com.github.liblevenshtein.collection.dictionary.ITransitionFunction Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of liblevenshtein-lite Show documentation

A library for spelling-correction based on Levenshtein Automata.

There is a newer version: 3.0.1

package com.github.liblevenshtein.collection.dictionary;

import java.io.Serializable;
import java.util.Iterator;

/**
 * Deterministically-transitions between states according to some input.
 * @author Dylon Edwards
 * @param  Kind of state this transition function accepts.
 * @since 2.1.0
 */
public interface ITransitionFunction extends Serializable {

  /**
   * Determines the next state given the current one and some input.
   * @param current The active state of an automaton
   * @param label Input used to determine the next state
   * @return The next state of the automaton
   */
  State of(State current, char label);

  /**
   * Returns the labels of the outgoing edges from the node.
   * @param current The active state of an automaton
   * @return The labels of the outgoing edges from the node.
   */
  Iterator of(State current);
}