Skip to content

Commit

Permalink
updated reference/bc
Browse files Browse the repository at this point in the history
  • Loading branch information
leonardolara committed Dec 2, 2024
1 parent 6ae2485 commit 390a158
Show file tree
Hide file tree
Showing 14 changed files with 718 additions and 186 deletions.
24 changes: 20 additions & 4 deletions reference/bc/functions/bcadd.xml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 23f5599c8cc2713e7a4fdc29d8cceab66c341c48 Maintainer: ae Status: ready --><!-- CREDITS: rarruda,ae -->
<!-- EN-Revision: ddb05f8827151e25dd1c3e058f95f6c024bc881b Maintainer: leonardolara Status: ready --><!-- CREDITS: rarruda,ae,leonardolara -->
<refentry xml:id="function.bcadd" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>bcadd</refname>
<refpurpose>Adicionar dois números de precisão arbitrária</refpurpose>
<refpurpose>Adiciona dois números de precisão arbitrária</refpurpose>
</refnamediv>

<refsect1 role="description">
Expand Down Expand Up @@ -52,6 +52,22 @@
</para>
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<para>
Esta função lança uma exceção <exceptionname>ValueError</exceptionname> nos seguintes casos:
<simplelist>
<member>
<parameter>num1</parameter> ou <parameter>num2</parameter>
não for uma string numérica BCMath bem formada.
</member>
<member>
<parameter>scale</parameter> estiver fora do intervalo válido.
</member>
</simplelist>
</para>
</refsect1>

<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
Expand All @@ -66,7 +82,7 @@
<row>
<entry>8.0.0</entry>
<entry>
<parameter>scale</parameter> pode ser null.
<parameter>scale</parameter> agora pode ser nulo.
</entry>
</row>
</tbody>
Expand All @@ -77,7 +93,7 @@
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Exemplo <function>bcadd</function></title>
<title>Exemplo de <function>bcadd</function></title>
<programlisting role="php">
<![CDATA[
<?php
Expand Down
101 changes: 101 additions & 0 deletions reference/bc/functions/bcceil.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: ddb05f8827151e25dd1c3e058f95f6c024bc881b Maintainer: leonardolara Status: ready -->
<refentry xml:id="function.bcceil" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>bcceil</refname>
<refpurpose>Arredonda para cima número de precisão arbitrária</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>bcceil</methodname>
<methodparam><type>string</type><parameter>num</parameter></methodparam>
</methodsynopsis>
<simpara>
Retorna o próximo valor inteiro mais alto, arredondando
<parameter>num</parameter> para cima se necessário.
</simpara>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>num</parameter></term>
<listitem>
<simpara>
O valor a ser arredondado.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
Retorna uma string numérica representando <parameter>num</parameter> arredondado para cima em direção ao inteiro mais próximo.
</simpara>
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<simpara>
Esta função lança uma exceção <exceptionname>ValueError</exceptionname> se
<parameter>num</parameter> não for uma string numérica BCMath bem formada.
</simpara>
</refsect1>

<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Exemplo de <function>bcceil</function></title>
<programlisting role="php">
<![CDATA[
<?php
var_dump(bcceil('4.3'));
var_dump(bcceil('9.999'));
var_dump(bcceil('-3.14'));
?>
]]>
</programlisting>
&example.outputs;
<screen role="php">
<![CDATA[
string(1) "5"
string(2) "10"
string(2) "-3"
]]>
</screen>
</example>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>bcfloor</function></member>
<member><function>bcround</function></member>
</simplelist>
</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
-->
59 changes: 15 additions & 44 deletions reference/bc/functions/bccomp.xml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 23f5599c8cc2713e7a4fdc29d8cceab66c341c48 Maintainer: ae Status: ready --><!-- CREDITS: rarruda,ae -->
<refentry xml:id="function.bccomp" xmlns="http://docbook.org/ns/docbook">
<!-- EN-Revision: ddb05f8827151e25dd1c3e058f95f6c024bc881b Maintainer: leonardolara Status: ready --><!-- CREDITS: rarruda,ae -->
<refentry xml:id="function.bccomp" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<refnamediv>
<refname>bccomp</refname>
<refpurpose>Comparar dois números de precisão arbitrária</refpurpose>
<refpurpose>Compara dois números de precisão arbitrária</refpurpose>
</refnamediv>

<refsect1 role="description">
Expand All @@ -15,55 +15,26 @@
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>scale</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Compara o <parameter>num1</parameter> com o
<parameter>num2</parameter> e retorna o resultado
como um inteiro.
Compara <parameter>num1</parameter> com <parameter>num2</parameter>
e retorna o resultado da comparação como um inteiro.
</para>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>num1</parameter></term>
<listitem>
<para>
O operando da esquerda, como uma string.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>num2</parameter></term>
<listitem>
<para>
O operando da direita, como uma string.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>scale</parameter></term>
<listitem>
<para>
O parâmetro opcional <parameter>scale</parameter> é usado para definir o
número de dígitos depois da parte decimal que será usada na
comparação.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('function.bcadd')/db:refsect1[@role='parameters']/*)" />
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retorna 0 se os dois operandos são iguais, 1 se o
<parameter>num1</parameter> é maior que
<parameter>num2</parameter>, -1 caso contrário.
</para>
<simpara>
Retorna <literal>0</literal> se ambos os operandos forem iguais,
<literal>1</literal> se <parameter>num1</parameter> for maior que
<parameter>num2</parameter>, <literal>-1</literal> para o restante.
</simpara>
</refsect1>

<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('function.bcadd')/db:refsect1[@role='errors'])" />

<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
Expand All @@ -78,7 +49,7 @@
<row>
<entry>8.0.0</entry>
<entry>
<parameter>scale</parameter> pode ser null.
<parameter>scale</parameter> pode ser nulo.
</entry>
</row>
</tbody>
Expand All @@ -89,7 +60,7 @@
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Exemplo da <function>bccomp</function></title>
<title>Exemplo de <function>bccomp</function></title>
<programlisting role="php">
<![CDATA[
<?php
Expand Down
33 changes: 14 additions & 19 deletions reference/bc/functions/bcdiv.xml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 87f32875a189be7ee2a8487c0db3958579e4ce72 Maintainer: ae Status: ready --><!-- CREDITS: rarruda,ae,leonardolara -->
<refentry xml:id="function.bcdiv" xmlns="http://docbook.org/ns/docbook">
<!-- EN-Revision: ddb05f8827151e25dd1c3e058f95f6c024bc881b Maintainer: leonardolara Status: ready --><!-- CREDITS: rarruda,ae,leonardolara -->
<refentry xml:id="function.bcdiv" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<refnamediv>
<refname>bcdiv</refname>
<refpurpose>Dividir dois números de precisão arbitrária</refpurpose>
<refpurpose>Divide dois números de precisão arbitrária</refpurpose>
</refnamediv>

<refsect1 role="description">
Expand All @@ -14,10 +14,9 @@
<methodparam><type>string</type><parameter>num2</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>scale</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Divide o <parameter>num1</parameter> pelo
<parameter>num2</parameter>.
</para>
<simpara>
Divide <parameter>num1</parameter> por <parameter>num2</parameter>.
</simpara>
</refsect1>

<refsect1 role="parameters">
Expand Down Expand Up @@ -53,17 +52,11 @@
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<para>
Esta função lança uma exceção <exceptionname>ValueError</exceptionname> nos seguintes casos:
<simplelist>
<member><parameter>num1</parameter> ou <parameter>num2</parameter> não são string numéricas BCMath bem formadas</member>
<member><parameter>scale</parameter> está fora do intervalo válido</member>
</simplelist>
</para>
<!-- Include standard ValueErrors for num1, num2, and scale, this includes the title -->
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('function.bcadd')/db:refsect1[@role='errors']/*)" />
<simpara>
Esta função lança uma exceção <exceptionname>DivisionByZeroError</exceptionname> se <parameter>num2</parameter>
for igual a <literal>0</literal>.
Esta função lança uma exceção <exceptionname>DivisionByZeroError</exceptionname>
se <parameter>num2</parameter> for igual a <literal>0</literal>.
</simpara>
</refsect1>

Expand All @@ -81,13 +74,15 @@
<row>
<entry>8.0.0</entry>
<entry>
<parameter>scale</parameter> pode ser null.
<parameter>scale</parameter> pode ser nulo.
</entry>
</row>
<row>
<entry>8.0.0</entry>
<entry>
Dividir por 0 agora lança uma exceção <exceptionname>DivisionByZeroError</exceptionname> ao invés de retornar null.
Dividir por <literal>0</literal> agora lança uma
exceção <exceptionname>DivisionByZeroError</exceptionname>
ao invés de retornar &null;.
</entry>
</row>
</tbody>
Expand Down
Loading

0 comments on commit 390a158

Please sign in to comment.