metdetection.meter.lpcfg

Class MetricalLpcfgHead

java.lang.Object

metdetection.meter.lpcfg.MetricalLpcfgHead

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MetricalLpcfgHead>

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

A MetricalLpcfgHead represents the head of a node in our lexicalized pcfg. It contains information about the longest note lying under a node, that note's location relative to the start of the beat, and whether that note begins from a tie. It's natural ordering is first by decreasing length, then by increasing startQuantum, and finally by tiesIn, where false comes first.

Author:

Andrew McLeod - 5 May, 2016

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private double	length The length of this head, normalized so that a value of 1.0 represents the sub beat length.
private static long	serialVersionUID Version 1
private double	startQuantum The offset of the quantum which begins the first occurrence of a note of this head's length in the current node, normalized so that a value of 1.0 represents the sub beat length.
private boolean	tiesIn True if this head starts with a TIE.

Constructor Summary

Constructors

Constructor and Description
MetricalLpcfgHead() Create a new empty head with length 0, startQuantum 0, and tiesIn false.
MetricalLpcfgHead(double length, double startQuantum, boolean tiesIn) Create a new head with the given fields.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(MetricalLpcfgHead other)
boolean	equals(java.lang.Object other)
double	getLength() Get the length of this head.
MetricalLpcfgHead	getShifted(double shiftLength) Get a new head with its startQuantum shifted right by some length.
int	hashCode()
java.lang.String	toString()

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

length

private final double length

The length of this head, normalized so that a value of 1.0 represents the sub beat length.

tiesIn

private final boolean tiesIn

True if this head starts with a TIE. False otherwise. This can only be true if startQuantum == 0.

startQuantum

private final double startQuantum

The offset of the quantum which begins the first occurrence of a note of this head's length in the current node, normalized so that a value of 1.0 represents the sub beat length.

Constructor Detail

MetricalLpcfgHead

public MetricalLpcfgHead()

Create a new empty head with length 0, startQuantum 0, and tiesIn false.

MetricalLpcfgHead

public MetricalLpcfgHead(double length,
                 double startQuantum,
                 boolean tiesIn)

Create a new head with the given fields.

Parameters:

length - length

startQuantum - startQuantum

tiesIn - tiesIn

Method Detail

getShifted

public MetricalLpcfgHead getShifted(double shiftLength)

Get a new head with its startQuantum shifted right by some length.

Parameters:

shiftLength - The length to shift startQuantum by.

Returns:

A new head, with its startQuantum shifted.

getLength

public double getLength()

Get the length of this head.

Returns:

length

compareTo

public int compareTo(MetricalLpcfgHead other)

Specified by:

compareTo in interface java.lang.Comparable<MetricalLpcfgHead>

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object