edu.isi.nlp.Accumulator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of common-core-open Show documentation

The newest version!

package edu.isi.nlp;

/**
 * An object which can accumulate objects of type {@code T} and return some sort of result of the
 * accumulation which is of the same type.
 *
 * This is inspired by FACTORIE's Accumulator class.
 *
 * @param 
 */
public interface Accumulator {

  /** Adds the provided data to the accumulator. */
  void accumulate(T data);

  /**
   * Adds all the data previously accumulated to the provided accumulator to this one.
   *
   * @param accumulator
   */
  void accumulate(Accumulator accumulator);

  /**
   * Get the current 'sum' for this accumulator.
   *
   * @return
   */
  T value();

  void reset();
}