archived-doc-ru/reference/bc/functions/bcsqrt.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 3295741565f760edd22e305bd10e37f243e9e194 Maintainer: tmn Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.bcsqrt" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
 <refnamediv>
  <refname>bcsqrt</refname>
  <refpurpose>
   Извлекает квадратный корень из числа произвольной точности
  </refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>bcsqrt</methodname>
   <methodparam><type>string</type><parameter>num</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>scale</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <simpara>
   Функция возвращает квадратный корень из числа <parameter>num</parameter>.
  </simpara>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>num</parameter></term>
     <listitem>
      <para>
       Операнд, подкоренное выражение, в виде корректно сформированной числовой строки BCMath.
      </para>
     </listitem>
    </varlistentry>
    <xi:include xpointer="function.bcadd..parameters.scale" />
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Функция возвращает квадратный корень в виде корректно сформированной
   числовой строки BCMath.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Функция выбрасывает ошибку <classname>ValueError</classname> в следующих случаях:
   <simplelist>
    <member>
     Значение аргумента <parameter>num</parameter> оказалось строкой,
     которую сформировали неправильно с точки зрения допустимого формата числовых строк в модуле BCMath
    </member>
    <member>
     Значение аргумента <parameter>num</parameter> меньше, чем <literal>0</literal>
    </member>
    <member>
     Значение аргумента <parameter>scale</parameter> выходит за пределы допустимого диапазона
    </member>
   </simplelist>
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       Функция выбрасывается ошибку <classname>ValueError</classname>,
       если значение аргумента <parameter>num</parameter> оказалось строкой,
       которую сформировали неправильно с точки зрения допустимого формата числовых строк в модуле BCMath,
       или меньше <literal>0</literal>;
       раньше вместо этого выдавалась ошибка уровня <constant>E_WARNING</constant>.
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       Допустимый диапазон значений параметра <parameter>scale</parameter> теперь
       лежит в пределах значений от <literal>0</literal> до <literal>2147483647</literal>;
       раньше функция воспринимала отрицательные значения как <literal>0</literal>.
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       Параметр <parameter>scale</parameter> теперь принимает значение &null;.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>Пример извлечения квадратного корня функцией <function>bcsqrt</function></title>
   <programlisting role="php">
<![CDATA[
<?php

echo bcsqrt('2', 3); // 1.414

?>
]]>
   </programlisting>
  </example>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>bcpow</function></member>
    <member><methodname>BcMath\Number::sqrt</methodname></member>
   </simplelist>
  </para>
 </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
-->