edu.stanford.nlp.stats.TwoDimensionalCounterInterface Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of stanford-corenlp Show documentation

Stanford CoreNLP provides a set of natural language analysis tools which can take raw English language text input and give the base forms of words, their parts of speech, whether they are names of companies, people, etc., normalize dates, times, and numeric quantities, mark up the structure of sentences in terms of phrases and word dependencies, and indicate which noun phrases refer to the same entities. It provides the foundational building blocks for higher level text understanding applications.

There is a newer version: 4.5.7

Show newest version

package edu.stanford.nlp.stats;

import java.text.NumberFormat;
import java.util.*;

/**
 * Interface representing a mapping between pairs of typed objects and double
 * values.
 *
 * @author Angel Chang
 */
public interface TwoDimensionalCounterInterface  {

  public void defaultReturnValue(double rv);
  public double defaultReturnValue();

  /**
   * @return total number of entries (key pairs)
   */
  public int size();

  public boolean containsKey(K1 o1, K2 o2);

  /**
   */
  public void incrementCount(K1 o1, K2 o2);

  /**
   */
  public void incrementCount(K1 o1, K2 o2, double count);

  /**
   */
  public void decrementCount(K1 o1, K2 o2);

  /**
   */
  public void decrementCount(K1 o1, K2 o2, double count);

  /**
   */
  public void setCount(K1 o1, K2 o2, double count);

  public double remove(K1 o1, K2 o2);

  /**
   */
  public double getCount(K1 o1, K2 o2);

  public double totalCount();

  /**
   */
  public double totalCount(K1 k1);

  public Set firstKeySet();

  public Set secondKeySet();

  public boolean isEmpty();

  public void remove(K1 key);

  public String toMatrixString(int cellSize);

  /**
   * Given an ordering of the first (row) and second (column) keys, will produce
   * a double matrix.
   */
  public double[][] toMatrix(List firstKeys, List secondKeys);

  public String toCSVString(NumberFormat nf);


  /** Counter based operations */

  /**
   * @return the inner Counter associated with key o
   */
  public Counter getCounter(K1 o);

  //public Set>> entrySet();

  /**
   * replace the counter for K1-index o by new counter c
   */
  //public Counter setCounter(K1 o, Counter c);

  //public Counter> flatten();

  //public void addAll(TwoDimensionalCounterInterface c);

  //public void addAll(K1 key, Counter c);

  //public void subtractAll(K1 key, Counter c);

  //public void subtractAll(TwoDimensionalCounterInterface c, boolean removeKeys);

  /**
   * Returns the counters with keys as the first key and count as the
   * total count of the inner counter for that key
   *
   * @return counter of type K1
   */
  //public Counter sumInnerCounter();

}