php-doc-en/reference/ssdeep/functions/ssdeep-fuzzy-compare.xml
Jakub Vrana 81ba8c58c0 Fix protos
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@308250 c90b9560-bf6c-de11-be94-00142212c4b1
2011-02-11 11:14:39 +00:00

77 lines
2 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.ssdeep-fuzzy-compare" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ssdeep_fuzzy_compare</refname>
<refpurpose>Calculates the match score between two fuzzy hash signatures</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>ssdeep_fuzzy_compare</methodname>
<methodparam><type>string</type><parameter>signature1</parameter></methodparam>
<methodparam><type>string</type><parameter>signature2</parameter></methodparam>
</methodsynopsis>
<para>
Calculates the match score between <parameter>signature1</parameter>
and <parameter>signature2</parameter> using <link xlink:href="&url.ssdeep.ctph;">
context-triggered piecewise hashing</link>, and returns the match
score.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>signature1</parameter></term>
<listitem>
<para>
The first fuzzy hash signature string.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>signature2</parameter></term>
<listitem>
<para>
The second fuzzy hash signature string.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an integer from 0 to 100 on success, &false; otherwise.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->