<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.splmaxheap.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'splmaxheap.compare.php',
    1 => 'SplMaxHeap::compare',
    2 => '要素を比較し、ヒープ内の適切な位置に置く',
  ),
  'up' => 
  array (
    0 => 'class.splmaxheap.php',
    1 => 'SplMaxHeap',
  ),
  'prev' => 
  array (
    0 => 'class.splmaxheap.php',
    1 => 'SplMaxHeap',
  ),
  'next' => 
  array (
    0 => 'class.splminheap.php',
    1 => 'SplMinHeap',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/spl/splmaxheap/compare.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="splmaxheap.compare" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">SplMaxHeap::compare</h1>
  <p class="verinfo">(PHP 5 &gt;= 5.3.0, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">SplMaxHeap::compare</span> &mdash; <span class="dc-title">要素を比較し、ヒープ内の適切な位置に置く</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-splmaxheap.compare-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">protected</span> <span class="methodname"><strong>SplMaxHeap::compare</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span> <code class="parameter">$value1</code></span>, <span class="methodparam"><span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span> <code class="parameter">$value2</code></span>): <span class="type"><a href="language.types.integer.php" class="type int">int</a></span></div>


  <p class="para rdfs-comment">
   <code class="parameter">value1</code> と <code class="parameter">value2</code> を比較します。
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-splmaxheap.compare-parameters">
  <h3 class="title">パラメータ</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">value1</code></dt>
     <dd>
      <p class="para">
       比較したい最初のノード。
      </p>
     </dd>
    
    
     <dt><code class="parameter">value2</code></dt>
     <dd>
      <p class="para">
       比較したい 2 番目のノード。
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-splmaxheap.compare-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="para">
   比較結果を返します。<code class="parameter">value1</code> が <code class="parameter">value2</code>
   より大きい場合は正の整数値、等しい場合は 0、
   小さい場合は負の整数値となります。
  </p>
  <blockquote class="note"><p><strong class="note">注意</strong>: 
   <p class="para">
    同一の値を持つ複数の要素をヒープ内に保持することはおすすめしません。
    そうすると、ヒープ内の相対位置がはっきりしなくなってしまいます。
   </p>
  </p></blockquote>
 </div>


</div><?php manual_footer($setup); ?>