edu.stanford.nlp.util
Class Beam

java.lang.Object
  |
  +--java.util.AbstractCollection
        |
        +--java.util.AbstractSet
              |
              +--edu.stanford.nlp.util.Beam
All Implemented Interfaces:
Collection, Set

public class Beam
extends AbstractSet

Implements a finite beam, taking a comparator (default is ScoredComparator.ASCENDING_COMPARATOR, the MAX object according to the comparator is the one to be removed) and a beam size on construction (default is 100). Adding an object may cause the worst-scored object to be removed from the beam (and that object may well be the newly added object itself.

Author:
Dan Klein

Field Summary
protected  Heap elements
           
protected  int maxBeamSize
           
 
Constructor Summary
Beam()
           
Beam(int maxBeamSize)
           
Beam(int maxBeamSize, Comparator cmp)
           
 
Method Summary
 boolean add(Object o)
           
 List asSortedList()
           
 int capacity()
           
 Iterator iterator()
           
static void main(String[] args)
           
 boolean remove(Object o)
           
 int size()
           
 
Methods inherited from class java.util.AbstractSet
equals, hashCode, removeAll
 
Methods inherited from class java.util.AbstractCollection
addAll, clear, contains, containsAll, isEmpty, retainAll, toArray, toArray, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.Set
addAll, clear, contains, containsAll, isEmpty, retainAll, toArray, toArray
 

Field Detail

maxBeamSize

protected int maxBeamSize

elements

protected Heap elements
Constructor Detail

Beam

public Beam()

Beam

public Beam(int maxBeamSize)

Beam

public Beam(int maxBeamSize,
            Comparator cmp)
Method Detail

capacity

public int capacity()

size

public int size()
Specified by:
size in interface Set
Specified by:
size in class AbstractCollection

iterator

public Iterator iterator()
Specified by:
iterator in interface Set
Specified by:
iterator in class AbstractCollection

asSortedList

public List asSortedList()

add

public boolean add(Object o)
Specified by:
add in interface Set
Overrides:
add in class AbstractCollection

remove

public boolean remove(Object o)
Specified by:
remove in interface Set
Overrides:
remove in class AbstractCollection

main

public static void main(String[] args)


Stanford NLP Group