Span (Stanford JavaNLP API)

java.lang.Object
- edu.stanford.nlp.ie.machinereading.structure.Span

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<java.lang.Integer>
```
public class Span
extends java.lang.Object
implements java.io.Serializable, java.lang.Iterable<java.lang.Integer>
```
Stores the offsets for a span of text Offsets may indicate either token or byte positions Start is inclusive, end is exclusive

Author:

Mihai

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Span(int s, int e)
This assumes that s <= e.

Span(Span... spans)
Creates a span that encloses all spans in the argument list.

Constructors
Constructor and Description
`Span(int s, int e)` This assumes that s <= e.
`Span(Span... spans)` Creates a span that encloses all spans in the argument list.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`contains(int i)` Returns true if i is inside this span.
`boolean`	`contains(Span otherSpan)` Returns true if this span contains otherSpan.
`static int`	`distance(Span a, Span b)` Returns the smallest distance between two spans.
`int`	`end()`
`boolean`	`equals(java.lang.Object other)`
`void`	`expandToInclude(Span otherSpan)`
`static Span`	`fromPair(IntPair span)` Another silly translation between a pair and a span.
`static Span`	`fromPair(Pair<java.lang.Integer,java.lang.Integer> span)` A silly translation between a pair and a span.
`static Span`	`fromPairOneIndexed(Pair<java.lang.Integer,java.lang.Integer> span)` A silly translation between a pair and a span.
`static Span`	`fromValues(int val1, int val2)` Safe way to construct Spans if you're not sure which value is higher.
`static Span`	`fromValues(java.lang.Object... values)`
`int`	`hashCode()`
`boolean`	`isAfter(Span otherSpan)` Returns true if this span starts after the otherSpan's end.
`boolean`	`isBefore(Span otherSpan)` Returns true if this span ends before the otherSpan starts.
`java.util.Iterator<java.lang.Integer>`	`iterator()`
`static int`	`overlap(Span spanA, Span spanB)`
`static boolean`	`overlaps(Span spanA, java.util.Collection<Span> spanB)`
`static boolean`	`overlaps(Span spanA, Span spanB)`
`void`	`setEnd(int e)`
`void`	`setStart(int s)`
`int`	`size()`
`int`	`start()`
`Span`	`toExclusive()` Convert an end-inclusive span to an end-exclusive span.
`Span`	`toInclusive()` Convert an end-exclusive span to an end-inclusive span.
`java.lang.String`	`toString()`
`Span`	`translate(int diff)` Move a span by the given amount.
`static Span`	`union(Span a, Span b)` The union of two spans.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - Span
```
public Span(int s,
            int e)
```
    This assumes that s <= e. Use fromValues if you can't guarantee this.
  - Span
```
public Span(Span... spans)
```
    Creates a span that encloses all spans in the argument list. Behavior is undefined if given no arguments.
- Method Detail
  - fromValues
```
public static Span fromValues(int val1,
                              int val2)
```
    Safe way to construct Spans if you're not sure which value is higher.
  - fromValues
```
public static Span fromValues(java.lang.Object... values)
```
  - start
```
public int start()
```
  - end
```
public int end()
```
  - setStart
```
public void setStart(int s)
```
  - setEnd
```
public void setEnd(int e)
```
  - 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
  - expandToInclude
```
public void expandToInclude(Span otherSpan)
```
  - contains
```
public boolean contains(Span otherSpan)
```
    Returns true if this span contains otherSpan. Endpoints on spans may match.
  - contains
```
public boolean contains(int i)
```
    Returns true if i is inside this span. Note that the start is inclusive and the end is exclusive.
  - isBefore
```
public boolean isBefore(Span otherSpan)
```
    Returns true if this span ends before the otherSpan starts.
    
    Throws:
    
    java.lang.IllegalArgumentException - if either span contains the other span
  - isAfter
```
public boolean isAfter(Span otherSpan)
```
    Returns true if this span starts after the otherSpan's end.
    
    Throws:
    
    java.lang.IllegalArgumentException - if either span contains the other span
  - translate
```
public Span translate(int diff)
```
    Move a span by the given amount. Useful for, e.g., switching between 0- and 1-indexed spans.
    
    Parameters:
    
    diff - The difference to ADD to both the beginning and end of the span. So, -1 moves the span left by one.
    
    Returns:
    
    A new span, offset by the given difference.
  - toInclusive
```
public Span toInclusive()
```
    Convert an end-exclusive span to an end-inclusive span.
  - toExclusive
```
public Span toExclusive()
```
    Convert an end-inclusive span to an end-exclusive span.
  - iterator
```
public java.util.Iterator<java.lang.Integer> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<java.lang.Integer>
  - size
```
public int size()
```
  - overlaps
```
public static boolean overlaps(Span spanA,
                               Span spanB)
```
  - overlap
```
public static int overlap(Span spanA,
                          Span spanB)
```
  - overlaps
```
public static boolean overlaps(Span spanA,
                               java.util.Collection<Span> spanB)
```
  - distance
```
public static int distance(Span a,
                           Span b)
```
    Returns the smallest distance between two spans.
  - fromPair
```
public static Span fromPair(Pair<java.lang.Integer,java.lang.Integer> span)
```
    A silly translation between a pair and a span.
  - fromPair
```
public static Span fromPair(IntPair span)
```
    Another silly translation between a pair and a span.
  - fromPairOneIndexed
```
public static Span fromPairOneIndexed(Pair<java.lang.Integer,java.lang.Integer> span)
```
    A silly translation between a pair and a span.
  - union
```
public static Span union(Span a,
                         Span b)
```
    The union of two spans. That is, the minimal span that contains both.

Class Span

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

Span

Span

Method Detail

fromValues

fromValues

start

end

setStart

setEnd

equals

hashCode

toString

expandToInclude

contains

contains

isBefore

isAfter

translate

toInclusive

toExclusive

iterator

size

overlaps

overlap

overlaps

distance

fromPair

fromPair

fromPairOneIndexed

union