Package etomica.util

Class TreeList

java.lang.Object

etomica.util.TreeList

All Implemented Interfaces:

java.io.Serializable

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

TreeList is a generic binary tree structure made up of TreeLinkers. Objects are added with a sortKey, which determines how it is added to the tree (left for objects with lower sort keys, right for objects with higher sort keys). The lowest event is always at the bottom on the left. Objects can be added and removed.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
TreeList()

Method Summary

Modifier and Type	Method	Description
void	add(TreeLinker newNode)
void	check()	checks the tree for consistency of connections and ordering by sortKey.
java.lang.Object	firstElement()	returns the object from the binary tree associated with the lowest sort-key, or null if the tree is empty
static void	remove(TreeLinker oldNode)
void	reset()	clear the tree by disconnecting everything from the head.

Methods inherited from class java.lang.Object

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

Constructor Detail

TreeList

public TreeList()

Method Detail

add

public void add(TreeLinker newNode)

remove

public static void remove(TreeLinker oldNode)

firstElement

public java.lang.Object firstElement()

returns the object from the binary tree associated with the lowest sort-key, or null if the tree is empty

Returns:

first object in the tree

reset

public void reset()

clear the tree by disconnecting everything from the head. Individual linkers will still be linked to each other (unless Debug is ON).

check

public void check()

checks the tree for consistency of connections and ordering by sortKey. circular (but consistent) links will cause this method to loop forever.