edu.stanford.nlp.ling.tokensregex.types.ValueFunction 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.ling.tokensregex.types;

import edu.stanford.nlp.ling.tokensregex.Env;

import java.util.List;

/**
 * A function that takes as input an environment (Env) and a list of values
 * ({@code List}) and returns a Value.
 *
 * @author Angel Chang
 */
public interface ValueFunction {

  /**
   * Checks if the arguments are valid.
   *
   * @param in
   * @return true if the arguments are valid (false otherwise)
   */
  boolean checkArgs(List in);

  /**
   * Applies the function to the list values using the environment as context
   * and returns the evaluated value.
   *
   * @param env the environment to use
   * @param in the input arguments
   * @return Value indicating the value of the function
   */
  Value apply(Env env, List in);

  /**
   * Returns a string describing what this function does.
   *
   * @return String describing the function
   */
  String getDescription();

}