<?xml version="1.0" encoding="utf-8"?>

<!-- $Revision$ -->

<!-- EN-Revision: 3295741565f760edd22e305bd10e37f243e9e194 Maintainer: hirokawa Status: ready -->

<!-- CREDITS: takagi -->

<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>

<parameter>num</parameter> が BCMath で有効でない数値形式の文字列だったり、

<literal>0</literal> より小さい場合、

<classname>ValueError</classname> がスローされるようになりました。

これより前のバージョンでは、<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> は、nullable になりました。

</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

-->