[PHPDOC] cvs: phpdoc /de/functions/ strings.xml /en/functions/ strings.xml From: Hartmut Holzgraefe (hholzgra <email protected>)
Date: 05/23/00

hholzgra Tue May 23 16:12:35 2000 EDT

  Modified files:
    /phpdoc/en/functions strings.xml
    /phpdoc/de/functions strings.xml
  Log:
  added documentation for the newly added function levdist()
  
  
Index: phpdoc/en/functions/strings.xml
diff -u phpdoc/en/functions/strings.xml:1.11 phpdoc/en/functions/strings.xml:1.12
--- phpdoc/en/functions/strings.xml:1.11 Sat May 20 07:04:26 2000
+++ phpdoc/en/functions/strings.xml Tue May 23 16:12:34 2000
@@ -750,6 +750,45 @@
    </refsect1>
   </refentry>
 
+ <refentry id="function.levdist">
+ <refnamediv>
+ <refname>ltrim</refname>
+ <refpurpose>
+ Calculate Levenshtein distance between two strings
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcdef>int <function>levdist</function></funcdef>
+ <paramdef>string <parameter>str1</parameter></paramdef>
+ <paramdef>string <parameter>str2</parameter></paramdef>
+ </funcsynopsis>
+ <para>
+ This function return the Levenshtein-Distance between the
+ two argument strings or -1, if one of the argument strings
+ is longer than the limit of 255 characters.
+ </para>
+ <para>
+ The Levenshtein distance is defined as the minimal number
+ of characters you have to replace, insert or delete to
+ transform <parameter>str1</parameter> into
+ <parameter>str2</parameter>.
+ The complexity of the algorithm is <literal>O(m*n)</literal>,
+ where <literal>n</literal> and <literal>m</literal> are the
+ length of <parameter>str1</parameter> and
+ <parameter>str2</parameter> (rather good when compared to
+ <function>similar_text</function>, which is O(max(n,m)**3),
+ but still expensive).
+ </para>
+ <para>
+ See also <function>soundex</function>,
+ <function>similar_text</function>
+ and <function>metaphone</function>.
+ </para>
+ </refsect1>
+ </refentry>
+
   <refentry id="function.ltrim">
    <refnamediv>
     <refname>ltrim</refname>
Index: phpdoc/de/functions/strings.xml
diff -u phpdoc/de/functions/strings.xml:1.8 phpdoc/de/functions/strings.xml:1.9
--- phpdoc/de/functions/strings.xml:1.8 Tue May 23 07:27:28 2000
+++ phpdoc/de/functions/strings.xml Tue May 23 16:12:35 2000
@@ -758,6 +758,45 @@
    </refsect1>
   </refentry>
 
+ <refentry id="function.levdist">
+ <refnamediv>
+ <refname>ltrim</refname>
+ <refpurpose>
+ Calculate Levenshtein distance between two strings
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcdef>int <function>levdist</function></funcdef>
+ <paramdef>string <parameter>str1</parameter></paramdef>
+ <paramdef>string <parameter>str2</parameter></paramdef>
+ </funcsynopsis>
+ <para>
+ This function return the Levenshtein-Distance between the
+ two argument strings or -1, if one of the argument strings
+ is longer than the limit of 255 characters.
+ </para>
+ <para>
+ The Levenshtein distance is defined as the minimal number
+ of characters you have to replace, insert or delete to
+ transform <parameter>str1</parameter> into
+ <parameter>str2</parameter>.
+ The complexity of the algorithm is <literal>O(m*n)</literal>,
+ where <literal>n</literal> and <literal>m</literal> are the
+ length of <parameter>str1</parameter> and
+ <parameter>str2</parameter> (rather good when compared to
+ <function>similar_text</function>, which is O(max(n,m)**3),
+ but still expensive).
+ </para>
+ <para>
+ See also <function>soundex</function>,
+ <function>similar_text</function>
+ and <function>metaphone</function>.
+ </para>
+ </refsect1>
+ </refentry>
+
   <refentry id="function.ltrim">
    <refnamediv>
     <refname>ltrim</refname>