<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.bc.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ru',
  ),
  'this' => 
  array (
    0 => 'function.bcmod.php',
    1 => 'bcmod',
    2 => 'Получает остаток от деления чисел произвольной точности',
  ),
  'up' => 
  array (
    0 => 'ref.bc.php',
    1 => 'Функции модуля BC Math',
  ),
  'prev' => 
  array (
    0 => 'function.bcfloor.php',
    1 => 'bcfloor',
  ),
  'next' => 
  array (
    0 => 'function.bcmul.php',
    1 => 'bcmul',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ru',
    'path' => 'reference/bc/functions/bcmod.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.bcmod" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">bcmod</h1>
  <p class="verinfo">(PHP 4, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">bcmod</span> &mdash; <span class="dc-title">
   Получает остаток от деления чисел произвольной точности
  </span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.bcmod-description">
  <h3 class="title">Описание</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>bcmod</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$num1</code></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$num2</code></span>, <span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.integer.php" class="type int">int</a></span></span> <code class="parameter">$scale</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>): <span class="type"><a href="language.types.string.php" class="type string">string</a></span></div>

  <p class="para rdfs-comment">
   Функция получает остаток от деления числа <code class="parameter">num1</code>
   на число <code class="parameter">num2</code>.
   Результат получит тот же знак, что и у числа <code class="parameter">num1</code>.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.bcmod-parameters">
  <h3 class="title">Список параметров</h3><p class="para">
   <dl>
    
     <dt><code class="parameter">num1</code></dt>
     <dd>
      <p class="para">
       Левый операнд (слагаемое) в виде строки.
      </p>
     </dd>
    
    
     <dt><code class="parameter">num2</code></dt>
     <dd>
      <p class="para">
       Правый операнд (слагаемое) в виде строки.
      </p>
     </dd>
    
    
     <dt><code class="parameter">scale</code></dt>
     <dd>
      <span class="simpara">
       Параметр используется для установки количества цифр после десятичного знака в результате.
       Если установлено значение <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong>, то по умолчанию будет установлен масштаб по умолчанию,
       заданный с помощью функции <span class="function"><a href="function.bcscale.php" class="function">bcscale()</a></span> или значение INI-директивы
       <a href="bc.configuration.php#ini.bcmath.scale" class="link"><code class="literal">bcmath.scale</code></a>.
      </span>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.bcmod-returnvalues">
  <h3 class="title">Возвращаемые значения</h3>
  <p class="para">
   Функция возвращает остаток от деления в виде строки.
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-function.bcmod-errors">
  
  <h3 class="title">Ошибки</h3><p class="para">
   Функция выбрасывает исключение <span class="exceptionname"><a href="class.valueerror.php" class="exceptionname">ValueError</a></span> в следующих случаях:
   <ul class="simplelist">
    <li>
     Значение аргумента <code class="parameter">num1</code> или <code class="parameter">num2</code> оказалось строкой,
     которую сформировали неправильно с точки зрения допустимого формата числовых строк в модуле BCMath.
    </li>
    <li>
     Значение аргумента <code class="parameter">scale</code> выходит за пределы допустимого диапазона.
    </li>
   </ul>
  </p>
  <p class="simpara">
   Функция выбрасывает исключение <span class="exceptionname"><a href="class.divisionbyzeroerror.php" class="exceptionname">DivisionByZeroError</a></span>,
   если число <code class="parameter">num2</code> равно <code class="literal">0</code>.
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.bcmod-changelog">
  <h3 class="title">Список изменений</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>Версия</th>
      <th>Описание</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
      <td>8.0.0</td>
      <td>
       Параметр <code class="parameter">scale</code> теперь принимает значение <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong>.
      </td>
     </tr>

     <tr>
      <td>8.0.0</td>
      <td>
       Деление на <code class="literal">0</code> теперь выбрасывает
       исключение <span class="exceptionname"><a href="class.divisionbyzeroerror.php" class="exceptionname">DivisionByZeroError</a></span> вместо возврата значения <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong>.
      </td>
     </tr>

     <tr>
      <td>7.2.0</td>
      <td>
       Числа <code class="parameter">num1</code> и <code class="parameter">num2</code> больше
       не усекаются до целого, поэтому поведение функции <span class="function"><strong>bcmod()</strong></span> теперь
       соответствует функции <span class="function"><a href="function.fmod.php" class="function">fmod()</a></span>, а не оператору <code class="literal">%</code>.
      </td>
     </tr>

     <tr>
      <td>7.2.0</td>
      <td>
       Добавили параметр <code class="parameter">scale</code>.
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 examples" id="refsect1-function.bcmod-examples">
  <h3 class="title">Примеры</h3>
  <div class="example" id="example-1">
   <p><strong>Пример #1 Пример получения остатка от деления функцией <span class="function"><strong>bcmod()</strong></span></strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br />bcscale</span><span style="color: #007700">(</span><span style="color: #0000BB">0</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #0000BB">bcmod</span><span style="color: #007700">( </span><span style="color: #DD0000">'5'</span><span style="color: #007700">,  </span><span style="color: #DD0000">'3'</span><span style="color: #007700">); </span><span style="color: #FF8000">//  2<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">bcmod</span><span style="color: #007700">( </span><span style="color: #DD0000">'5'</span><span style="color: #007700">, </span><span style="color: #DD0000">'-3'</span><span style="color: #007700">); </span><span style="color: #FF8000">//  2<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">bcmod</span><span style="color: #007700">(</span><span style="color: #DD0000">'-5'</span><span style="color: #007700">,  </span><span style="color: #DD0000">'3'</span><span style="color: #007700">); </span><span style="color: #FF8000">// -2<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">bcmod</span><span style="color: #007700">(</span><span style="color: #DD0000">'-5'</span><span style="color: #007700">, </span><span style="color: #DD0000">'-3'</span><span style="color: #007700">); </span><span style="color: #FF8000">// -2<br /><br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

  </div>
  <div class="example" id="example-2">
   <p><strong>Пример #2 Пример получения остатка от деления чисел с десятичными знаками функцией <span class="function"><strong>bcmod()</strong></span></strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br />bcscale</span><span style="color: #007700">(</span><span style="color: #0000BB">1</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #0000BB">bcmod</span><span style="color: #007700">(</span><span style="color: #DD0000">'5.7'</span><span style="color: #007700">, </span><span style="color: #DD0000">'1.3'</span><span style="color: #007700">); </span><span style="color: #FF8000">// 0.5 с PHP 7.2.0; 0 ранее<br /><br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.bcmod-seealso">
  <h3 class="title">Смотрите также</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.bcdiv.php" class="function" rel="rdfs-seeAlso">bcdiv()</a> - Делит два числа произвольной точности</span></li>
    <li><span class="function"><a href="function.bcdivmod.php" class="function" rel="rdfs-seeAlso">bcdivmod()</a> - Получает неполное частное и остаток от деления числа произвольной точности</span></li>
    <li><span class="methodname"><a href="bcmath-number.mod.php" class="methodname" rel="rdfs-seeAlso">BcMath\Number::mod()</a> - Получает остаток от деления числа произвольной точности</span></li>
   </ul>
  </p>
 </div>

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