Files
doc-fr/reference/spl/splminheap/compare.xml
2021-06-08 16:49:14 +01:00

87 lines
2.3 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: dd07341fae2c414adc1f700be0890ff32e8daab4 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="splminheap.compare" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>SplMinHeap::compare</refname>
<refpurpose>Compare deux éléments</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>protected</modifier> <type>int</type><methodname>SplMinHeap::compare</methodname>
<methodparam><type>mixed</type><parameter>value1</parameter></methodparam>
<methodparam><type>mixed</type><parameter>value2</parameter></methodparam>
</methodsynopsis>
<para>
Compare la valeur <parameter>value1</parameter> avec la
valeur <parameter>value2</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>value1</parameter></term>
<listitem>
<para>
La valeur du premier nœud à comparer.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value2</parameter></term>
<listitem>
<para>
La valeur du second nœud à comparer.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Le résultat de la comparaison ; un entier positif si la valeur
<parameter>value1</parameter> est plus petite que la valeur
<parameter>value2</parameter>, 0 si les valeurs sont égales, et un
entier négatif sinon.
</para>
<note>
<para>
Avoir plusieurs éléments avec la même valeur dans un tas n'est pas
recommandé. Cela peut conduire en des positions arbitraires.
</para>
</note>
</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
-->