metdetection.meter.lpcfg

Class MetricalLpcfgTerminal

java.lang.Object

metdetection.meter.lpcfg.MetricalLpcfgTerminal

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MetricalLpcfgTerminal>, MetricalLpcfgNode

public class MetricalLpcfgTerminal
extends java.lang.Object
implements MetricalLpcfgNode, java.lang.Comparable<MetricalLpcfgTerminal>, java.io.Serializable

A MetricalLpcfgTerminal object represents a terminal symbol in the rhythmic grammar. That is, any pattern of ties, notes, and rests which make up an entire sub-beat in a given song's metrical structure. It is made up of a List of MetricalLpcfgQuantums.

Author:

Andrew McLeod - 24 February, 2016

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private int	baseLength The base length of this terminal, used to normalize in getHead().
private MetricalLpcfgQuantum[]	originalPattern The pattern of quantums that make up this terminal, in unreduced form.
private MetricalLpcfgQuantum[]	reducedPattern The pattern of quantums that make up this terminal, in fully reduced form.
private static long	serialVersionUID Version 1

Constructor Summary

Constructors

Modifier	Constructor and Description
	MetricalLpcfgTerminal() Create a new terminal with just a single rest.
	MetricalLpcfgTerminal(MetricalLpcfgQuantum[] pattern) Create a new MetricalGrammarTerminal with the given pattern and baseLength of 1.
	MetricalLpcfgTerminal(MetricalLpcfgQuantum[] pattern, int baseLength) Create a new MetricalGrammarTerminal with the given pattern and base length.
private	MetricalLpcfgTerminal(MetricalLpcfgTerminal terminal) Create a new MetricalGrammarTerminal, a shallow copy of the given one.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(MetricalLpcfgTerminal o)
MetricalLpcfgTerminal	deepCopy() Return a copy of this terminal.
boolean	equals(java.lang.Object other)
private static MetricalLpcfgQuantum[]	generateReducedPattern(MetricalLpcfgQuantum[] pattern) Convert the given pattern into reduced form and return it.
private static int	getGCF(MetricalLpcfgQuantum[] pattern) Get the greatest common factor of the lengths of all of the constituents in the given pattern.
MetricalLpcfgHead	getHead() Get the head of this terminal.
int	getLength() Get the length of this node, measured in sub beats.
MetricalLpcfgQuantum[]	getOriginalPattern() Get the original unreduced pattern of this terminal.
MetricalLpcfgQuantum[]	getReducedPattern() Get the pattern of this terminal.
MetricalLpcfgTerminal	getTerminal() Get the terminal at this level of the tree.
int	hashCode()
private static void	incrementLast(java.util.List<java.lang.Integer> list) Utility method to increment the last value in an Integer List.
boolean	isEmpty() Get whether this terminal contains any notes or not.
boolean	startsWithRest() Get if this node starts with a REST or not.
java.lang.String	toString()
java.lang.String	toStringPretty(int depth, java.lang.String tab) Get the recursive String of this terminal.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

Version 1

See Also:

Constant Field Values

reducedPattern

private final MetricalLpcfgQuantum[] reducedPattern

The pattern of quantums that make up this terminal, in fully reduced form.

originalPattern

private final MetricalLpcfgQuantum[] originalPattern

The pattern of quantums that make up this terminal, in unreduced form.

baseLength

private final int baseLength

The base length of this terminal, used to normalize in getHead().

Constructor Detail

MetricalLpcfgTerminal

public MetricalLpcfgTerminal()

Create a new terminal with just a single rest.

MetricalLpcfgTerminal

public MetricalLpcfgTerminal(MetricalLpcfgQuantum[] pattern)

Create a new MetricalGrammarTerminal with the given pattern and baseLength of 1. This will convert the given pattern into reduced form before saving it.

Parameters:

pattern - The given pattern, in non-reduced form.

MetricalLpcfgTerminal

public MetricalLpcfgTerminal(MetricalLpcfgQuantum[] pattern,
                     int baseLength)

Create a new MetricalGrammarTerminal with the given pattern and base length. This will convert the given pattern into reduced form before saving it.

Parameters:

pattern - The given pattern, in non-reduced form.

baseLength - baseLength

MetricalLpcfgTerminal

private MetricalLpcfgTerminal(MetricalLpcfgTerminal terminal)

Create a new MetricalGrammarTerminal, a shallow copy of the given one.

Method Detail

generateReducedPattern

private static MetricalLpcfgQuantum[] generateReducedPattern(MetricalLpcfgQuantum[] pattern)

Convert the given pattern into reduced form and return it. That is, divide all constituent lengths by their GCF.

Parameters:

pattern - The pattern we want to reduce.

Returns:

The given pattern in fully reduced form.

getGCF

private static int getGCF(MetricalLpcfgQuantum[] pattern)

Get the greatest common factor of the lengths of all of the constituents in the given pattern.

Parameters:

pattern - The pattern we want to reduce.

Returns:

The greatest common factor of the constituents of the given pattern.

incrementLast

private static void incrementLast(java.util.List<java.lang.Integer> list)

Utility method to increment the last value in an Integer List.

Parameters:

list - The Integer List whose last value we want to increment.

isEmpty

public boolean isEmpty()

Get whether this terminal contains any notes or not.

Specified by:

isEmpty in interface MetricalLpcfgNode

Returns:

True if this terminal constins no notes (is all RESTS). False otherwise.

startsWithRest

public boolean startsWithRest()

Description copied from interface: MetricalLpcfgNode

Get if this node starts with a REST or not.

Specified by:

startsWithRest in interface MetricalLpcfgNode

Returns:

True if this node starts with a REST. False otherwise.

getHead

public MetricalLpcfgHead getHead()

Get the head of this terminal.

Specified by:

getHead in interface MetricalLpcfgNode

Returns:

The head of this terminal.

getLength

public int getLength()

Description copied from interface: MetricalLpcfgNode

Get the length of this node, measured in sub beats.

Specified by:

getLength in interface MetricalLpcfgNode

Returns:

The length of this node in sub beats.

getReducedPattern

public MetricalLpcfgQuantum[] getReducedPattern()

Get the pattern of this terminal.

Returns:

reducedPattern

getOriginalPattern

public MetricalLpcfgQuantum[] getOriginalPattern()

Get the original unreduced pattern of this terminal.

Returns:

originalPattern

getTerminal

public MetricalLpcfgTerminal getTerminal()

Description copied from interface: MetricalLpcfgNode

Get the terminal at this level of the tree.

Specified by:

getTerminal in interface MetricalLpcfgNode

Returns:

The terminal at this node.

deepCopy

public MetricalLpcfgTerminal deepCopy()

Return a copy of this terminal.

Specified by:

deepCopy in interface MetricalLpcfgNode

Returns:

A copy of this terminal.

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toStringPretty

public java.lang.String toStringPretty(int depth,
                              java.lang.String tab)

Get the recursive String of this terminal. That is, the one that shows probabilities.

Specified by:

toStringPretty in interface MetricalLpcfgNode

Parameters:

depth - The depth of this node.

tab - The tab String to indent tree levels.

Returns:

The recursive String of this terminal.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(MetricalLpcfgTerminal o)

Specified by:

compareTo in interface java.lang.Comparable<MetricalLpcfgTerminal>