dag

Class Score

java.lang.Object

dag.Score

All Implemented Interfaces:

java.lang.Comparable<Score>

public final class Score
extends java.lang.Object
implements java.lang.Comparable<Score>

Class Score represents a similarity score for a pair of trees.

Instances of class Score are immutable.

Constructor Summary

Constructors

Constructor and Description
Score(int nodeA, int nodeB, float score, boolean isMergeable) Constructs a new Score instance.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Score other) Returns -1, 0, or 1 depending on whether this Score is less than, equal to, or greater than the specified Score.
boolean	equals(java.lang.Object obj) Compares the specified object with this Score for equality.
int	hashCode() Returns the hash code value for this object.
boolean	isMergeable() Returns true if the two trees may be merged, and returns false otherwise.
int	nodeA() Returns the root node index for the first tree.
int	nodeB() Returns the root node index for the second tree.
float	score() Returns the similarity score for the two trees.
java.lang.String	toString() Returns a string representation of this.

Methods inherited from class java.lang.Object

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

Constructor Detail

Score

public Score(int nodeA,
             int nodeB,
             float score,
             boolean isMergeable)

Constructs a new Score instance. Smaller similarity scores correspond to greater similarity.

Parameters:

nodeA - root node index for the first tree

nodeB - root node index for the second tree

score - the a non-negative similarity score for the two specified trees

isMergeable - true if the two trees may be merged, and false otherwise

Throws:

java.lang.IllegalArgumentException - if score < 0 || (score==0 && isMergeable==false)

java.lang.IllegalArgumentException - if Float.isNaN(score)

Method Detail

nodeA

public int nodeA()

Returns the root node index for the first tree.

Returns:

the root node index for the first tree

nodeB

public int nodeB()

Returns the root node index for the second tree.

Returns:

the root node index for the second tree

score

public float score()

Returns the similarity score for the two trees.

Returns:

the similarity score for the two trees

isMergeable

public boolean isMergeable()

Returns true if the two trees may be merged, and returns false otherwise.

Returns:

true if the two trees may be merged, and returns false otherwise

equals

public boolean equals(java.lang.Object obj)

Compares the specified object with this Score for equality. Returns true if the specified object is a Score instance whose nodeA(), nodeB(), score(), and isMergeable() methods return the same values as the corresponding methods for this, and returns false otherwise.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object to be compared for equality with this Score

Returns:

true if the specified object is a equal to this

hashCode

public int hashCode()

Returns the hash code value for this object. The hash code is defined by the following calculation:

  int hash = 5;
  hash = 53 * hash + this.nodeA();
  hash = 53 * hash + this.nodeB();
  hash = 53 * hash + Float.floatToIntBits(this.score());
     

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code value for the object

compareTo

public int compareTo(Score other)

Returns -1, 0, or 1 depending on whether this Score is less than, equal to, or greater than the specified Score. The two scores are ordered first using -Boolean.compare() on the value returned by isMergeable(), then by Float.compare() on the value returned by score(), then by the value returned by nodeA(), and then by the value returned by nodeB().

Specified by:

compareTo in interface java.lang.Comparable<Score>

Parameters:

other - a Score element to be compared

Returns:

a negative integer, zero, or a positive integer depending on whether this Score is less than, equal to, or greater than the specified Score

Throws:

java.lang.NullPointerException - if other == null

toString

public java.lang.String toString()

Returns a string representation of this. The exact details of the representation are unspecified and subject to change.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this