net.sourceforge.phpeclipse.ui/src/net/sourceforge/phpdt/internal/ui/text/spelling/engine/IPhoneticDistanceAlgorithm.java

   1 /*******************************************************************************
   2  * Copyright (c) 2000, 2003 IBM Corporation and others.
   3  * All rights reserved. This program and the accompanying materials
   4  * are made available under the terms of the Common Public License v1.0
   5  * which accompanies this distribution, and is available at
   6  * http://www.eclipse.org/legal/cpl-v10.html
   7  *
   8  * Contributors:
   9  *     IBM Corporation - initial API and implementation
  10  *******************************************************************************/
  11
  12 package net.sourceforge.phpdt.internal.ui.text.spelling.engine;
  13
  14 /**
  15  * Interface of algorithms to compute the phonetic distance between two words.
  16  *
  17  * @since 3.0
  18  */
  19 public interface IPhoneticDistanceAlgorithm {
  20
  21         /**
  22          * Returns the non-negative phonetic distance between two words
  23          *
  24          * @param from
  25          *            The first word
  26          * @param to
  27          *            The second word
  28          * @return The non-negative phonetic distance between the words.
  29          */
  30         public int getDistance(String from, String to);
  31 }