<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.gmp.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' => 
  array (
    0 => 'function.gmp-jacobi.php',
    1 => 'gmp_jacobi',
    2 => 'Jacobi symbol',
  ),
  'up' => 
  array (
    0 => 'ref.gmp.php',
    1 => 'GMP Functions',
  ),
  'prev' => 
  array (
    0 => 'function.gmp-invert.php',
    1 => 'gmp_invert',
  ),
  'next' => 
  array (
    0 => 'function.gmp-kronecker.php',
    1 => 'gmp_kronecker',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/gmp/functions/gmp-jacobi.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.gmp-jacobi" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">gmp_jacobi</h1>
  <p class="verinfo">(PHP 4 &gt;= 4.0.4, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">gmp_jacobi</span> &mdash; <span class="dc-title">Jacobi symbol</span></p>

 </div>
 
 <div class="refsect1 description" id="refsect1-function.gmp-jacobi-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>gmp_jacobi</strong></span>(<span class="methodparam"><span class="type"><span class="type"><a href="class.gmp.php" class="type GMP">GMP</a></span>|<span class="type"><a href="language.types.integer.php" class="type int">int</a></span>|<span class="type"><a href="language.types.string.php" class="type string">string</a></span></span> <code class="parameter">$num1</code></span>, <span class="methodparam"><span class="type"><span class="type"><a href="class.gmp.php" class="type GMP">GMP</a></span>|<span class="type"><a href="language.types.integer.php" class="type int">int</a></span>|<span class="type"><a href="language.types.string.php" class="type string">string</a></span></span> <code class="parameter">$num2</code></span>): <span class="type"><a href="language.types.integer.php" class="type int">int</a></span></div>

  <p class="para rdfs-comment">
   Computes
   <a href="http://primes.utm.edu/glossary/page.php?sort=JacobiSymbol" class="link external">&raquo;&nbsp;Jacobi symbol</a> of <code class="parameter">num1</code> and
   <code class="parameter">num2</code>. <code class="parameter">num2</code> should be odd
   and must be positive.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.gmp-jacobi-parameters">
  <h3 class="title">Parameters</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">num1</code></dt>
     <dd>
      <p class="para">
 A <span class="classname"><a href="class.gmp.php" class="classname">GMP</a></span> object, an <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>,
 or a <span class="type"><a href="language.types.string.php" class="type string">string</a></span> that can be interpreted as a number following the same logic
 as if the string was used in <span class="function"><a href="function.gmp-init.php" class="function">gmp_init()</a></span> with automatic
 base detection (i.e. when <code class="parameter">base</code> is equal to 0).
</p> 
     </dd>
    
    
     <dt><code class="parameter">num2</code></dt>
     <dd>
      <p class="para">
 A <span class="classname"><a href="class.gmp.php" class="classname">GMP</a></span> object, an <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>,
 or a <span class="type"><a href="language.types.string.php" class="type string">string</a></span> that can be interpreted as a number following the same logic
 as if the string was used in <span class="function"><a href="function.gmp-init.php" class="function">gmp_init()</a></span> with automatic
 base detection (i.e. when <code class="parameter">base</code> is equal to 0).
</p> 
      <p class="para">
       Should be odd and must be positive.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.gmp-jacobi-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="para">
   A <span class="classname"><a href="class.gmp.php" class="classname">GMP</a></span> object.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.gmp-jacobi-examples">
  <h3 class="title">Examples</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Example #1 <span class="function"><strong>gmp_jacobi()</strong></span> example</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">gmp_jacobi</span><span style="color: #007700">(</span><span style="color: #DD0000">"1"</span><span style="color: #007700">, </span><span style="color: #DD0000">"3"</span><span style="color: #007700">) . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />echo </span><span style="color: #0000BB">gmp_jacobi</span><span style="color: #007700">(</span><span style="color: #DD0000">"2"</span><span style="color: #007700">, </span><span style="color: #DD0000">"3"</span><span style="color: #007700">) . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

    <div class="example-contents"><p>The above example will output:</p></div>
    <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">1
0</pre>
</div>
    </div>
   </div>
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.gmp-jacobi-seealso">
  <h3 class="title">See Also</h3>
  <ul class="simplelist">
   <li><span class="function"><a href="function.gmp-kronecker.php" class="function" rel="rdfs-seeAlso">gmp_kronecker()</a> - Kronecker symbol</span></li>
   <li><span class="function"><a href="function.gmp-legendre.php" class="function" rel="rdfs-seeAlso">gmp_legendre()</a> - Legendre symbol</span></li>
  </ul>
 </div>


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