php-doc-en/reference/sphinx/sphinxclient/setrankingmode.xml
Torben Wilson af4410a7e1 Normalized the sgml-default-dtd-file local-variable line for those
still using this, after discussion on the phpdoc list.
From now on, manual.ced will need to be found at ~/.phpdoc/manual.ced.



git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@288721 c90b9560-bf6c-de11-be94-00142212c4b1
2009-09-25 07:04:39 +00:00

105 lines
2.6 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="sphinxclient.setrankingmode" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SphinxClient::setRankingMode</refname>
<refpurpose>Set ranking mode</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>SphinxClient::setRankingMode</methodname>
<methodparam><type>int</type><parameter>ranker</parameter></methodparam>
</methodsynopsis>
<para>
Sets ranking mode. Only available in
<constant>SPH_MATCH_EXTENDED2</constant> matching mode.
<table>
<title>Ranking modes</title>
<tgroup cols="2">
<thead>
<row>
<entry>Constant</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>SPH_RANK_PROXIMITY_BM25</entry>
<entry>Default ranking mode which uses both proximity and BM25
ranking.</entry>
</row>
<row>
<entry>SPH_RANK_BM25</entry>
<entry>Statistical ranking mode which uses BM25 ranking only (similar
to most of other full-text engines). This mode is faster, but may result
in worse quality on queries which contain more than 1 keyword.</entry>
</row>
<row>
<entry>SPH_RANK_NONE</entry>
<entry>Disables ranking. This mode is the fastest. It is essentially
equivalent to boolean searching, a weight of 1 is assigned to all
matches.</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>ranker</parameter></term>
<listitem>
<para>
Ranking mode.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="sphinxclient.setmatchmode" /></member>
</simplelist>
</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
-->