ai.eloquent.util

Class Span

java.lang.Object

ai.eloquent.util.Span

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Span>, java.lang.Iterable<java.lang.Long>

public class Span
extends java.lang.Object
implements java.lang.Iterable<java.lang.Long>, java.lang.Comparable<Span>, java.io.Serializable

A span, inclusive of begin and exclusive of end.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
long	begin The beginning of this span, inclusive.
long	end The end of this span, exclusive.

Constructor Summary

Constructors

Constructor and Description
Span(long begin, long end) Create a new span from two values.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Span o)
boolean	contains(int i) If true, the value is contined in the span.
boolean	contains(Span other) Returns true if this span contains the argument span.
boolean	equals(java.lang.Object o)
static Span	fromValues(long a, long b) Create a span from two values.
int	hashCode()
static Span	intersect(Span a, Span b) Returns the intersection between two spans.
java.util.Iterator<java.lang.Long>	iterator()
long	length() The length of this span -- i.e., the distance from begin to end.
long	middle() The middle (average?) of the span.
long	overlap(Span other) Returns the amount of overlap between this span and the argument span.
boolean	overlaps(Span other) Returns true if there's any overlap between this span and the argument span.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

begin

public final long begin

The beginning of this span, inclusive.

end

public final long end

The end of this span, exclusive.

Constructor Detail

Span

public Span(long begin,
            long end)

Create a new span from two values.

Parameters:

begin - The beginning of the span, inclusive.

end - The end of the span, exclusive.

Method Detail

contains

public boolean contains(Span other)

Returns true if this span contains the argument span. This includes the case when the two spans are the same.

Parameters:

other - The other span.

Returns:

True if the argument span is contained in this span.

length

public long length()

The length of this span -- i.e., the distance from begin to end.

overlaps

public boolean overlaps(Span other)

Returns true if there's any overlap between this span and the argument span.

Parameters:

other - The other span to compare this span to.

Returns:

True if this and the other span have any overlap.

overlap

public long overlap(Span other)

Returns the amount of overlap between this span and the argument span.

Parameters:

other - The argument span.

Returns:

The number of tokens that overlap between the two spans.

intersect

public static Span intersect(Span a,
                             Span b)

Returns the intersection between two spans.

Parameters:

a - The first span.

b - The second span.

Returns:

A span denoting the intersection between the two spans.

fromValues

public static Span fromValues(long a,
                              long b)

Create a span from two values.

Parameters:

a - One of the values (not necessarily the smaller).

b - The other value (not necessarily bigger).

Returns:

The span between a and b.

equals

public boolean equals(java.lang.Object o)

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

iterator

public java.util.Iterator<java.lang.Long> iterator()

Specified by:

iterator in interface java.lang.Iterable<java.lang.Long>

compareTo

public int compareTo(Span o)

Specified by:

compareTo in interface java.lang.Comparable<Span>

contains

public boolean contains(int i)

If true, the value is contined in the span. This is defined with an inclusive begin index and an exclusive end index.

Parameters:

i - The value we are checking.

Returns:

True if begin <= i < end.

middle

public long middle()

The middle (average?) of the span. That is, (end + begin / 2).