1
0
mirror of https://github.com/php/doc-ja.git synced 2026-03-25 15:42:08 +01:00
Files
archived-doc-ja/reference/spl/splpriorityqueue/compare.xml
2022-12-13 20:19:04 +09:00

83 lines
2.4 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: d51166ca16fda8e766849505b84f9306ef443f71 Maintainer: takagi Status: ready -->
<refentry xml:id="splpriorityqueue.compare" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>SplPriorityQueue::compare</refname>
<refpurpose>要素の優先順位を比較し、ヒープ内の適切な位置に置く</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="SplPriorityQueue">
<modifier>public</modifier> <type>int</type><methodname>SplPriorityQueue::compare</methodname>
<methodparam><type>mixed</type><parameter>priority1</parameter></methodparam>
<methodparam><type>mixed</type><parameter>priority2</parameter></methodparam>
</methodsynopsis>
<para>
<parameter>priority1</parameter><parameter>priority2</parameter> を比較します。
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>priority1</parameter></term>
<listitem>
<para>
比較したい最初のノードの優先順位。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>priority2</parameter></term>
<listitem>
<para>
比較したい 2 番目のノードの優先順位。
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
比較結果を返します。<parameter>priority1</parameter><parameter>priority2</parameter>
より大きい場合は正の整数値、等しい場合は 0、
小さい場合は負の整数値となります。
</para>
<note>
<para>
同一の優先順位の要素が複数存在する場合は、
キューから取り出す際の順序が不定となります。
</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
-->