<?xml version="1.0" encoding="utf-8"?>

<refentry xml:id="function.similar-text" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>similar_text</refname>

<refpurpose>Calculate the similarity between two strings</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type>int</type><methodname>similar_text</methodname>

<methodparam><type>string</type><parameter>string1</parameter></methodparam>

<methodparam><type>string</type><parameter>string2</parameter></methodparam>

<methodparam choice="opt"><type>float</type><parameter role="reference">percent</parameter><initializer>&null;</initializer></methodparam>

</methodsynopsis>

<para>

This calculates the similarity between two strings as described in

&book.programming.classics;. Note that this implementation does not use a

stack as in Oliver's pseudo code, but recursive calls which may or may not

speed up the whole process. Note also that the complexity of this algorithm

is O(N**3) where N is the length of the longest string.

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>string1</parameter></term>

<listitem>

<para>

The first string.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>string2</parameter></term>

<listitem>

<para>

The second string.

</para>

<note>

<para>

Swapping the <parameter>string1</parameter> and

<parameter>string2</parameter> may yield a different result; see the

example below.

</para>

</note>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>percent</parameter></term>

<listitem>

<para>

By passing a reference as third argument,

<function>similar_text</function> will calculate the similarity in

percent, by dividing the result of <function>similar_text</function> by

the average of the lengths of the given strings times

<literal>100</literal>.

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

Returns the number of matching chars in both strings.

</para>

<para>

The number of matching characters is calculated by finding the longest first

common substring, and then doing this for the prefixes and the suffixes,

recursively. The lengths of all found common substrings are added.

</para>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<example xml:id="similar_text.example.swapping">

<title><function>similar_text</function> argument swapping example</title>

<para>

This example shows that swapping the <parameter>string1</parameter> and

<parameter>string2</parameter> argument may yield different results.

</para>

<programlisting role="php">

</programlisting>

&example.outputs.similar;

<screen>

</screen>

</example>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<para>

<simplelist>

<member><function>levenshtein</function></member>

<member><function>metaphone</function></member>

<member><function>soundex</function></member>

</simplelist>

</para>

</refsect1>

</refentry>