edu.stanford.math.plex

Class SimplexStream.Head

java.lang.Object

edu.stanford.math.plex.SimplexStream.Head

Enclosing class:

SimplexStream

public static class SimplexStream.Head
extends java.lang.Object

A Head provides the FO part of a FIFO queue when attached to a Tail to which simplices have been enqueued.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SimplexStream.Head()
	SimplexStream.Head(SimplexStream.Tail q)

Method Summary

Methods

Modifier and Type	Method and Description
SimplexStream.Head	copy()
boolean	eql(SimplexStream.Head q) Check equality of Head with another.
boolean	lessThan(SimplexStream.Head q) Compare one Head to another.
Simplex	nextEntry() Get the next entry from the underlying Queue.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SimplexStream.Head

protected SimplexStream.Head()

SimplexStream.Head

public SimplexStream.Head(SimplexStream.Tail q)

Method Detail

copy

public SimplexStream.Head copy()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

nextEntry

public Simplex nextEntry()

Get the next entry from the underlying Queue.

This only works is we don't outrun the underlying Tail.

Returns:

next Simplex in the Queue.

lessThan

public boolean lessThan(SimplexStream.Head q)

Compare one Head to another.

This is a very fast comparison that will only work if both Head instances are heads for the same Tail.

Parameters:

q - Head to compare

Returns:

true if this is prior to q, else false.

eql

public boolean eql(SimplexStream.Head q)

Check equality of Head with another.

This is used only by assertions.

Parameters:

q - Head to compare

Returns:

true if this is equal to q, else false.