Skip to content

Commit

Permalink
initial translation in bcmath/number
Browse files Browse the repository at this point in the history
  • Loading branch information
leonardolara committed Jan 25, 2025
1 parent 444b856 commit 170e43e
Show file tree
Hide file tree
Showing 4 changed files with 488 additions and 0 deletions.
193 changes: 193 additions & 0 deletions reference/bc/bcmath/number/add.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,193 @@
<?xml version="1.0" encoding="utf-8"?><!-- EN-Revision: c7e83fbbbcde9f54affc09424d032c38492a3ff4 Maintainer: leonardolara Status: ready -->
<refentry xml:id="bcmath-number.add" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>BcMath\Number::add</refname>
<refpurpose>Adiciona um número de precisão arbitrária</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="BcMath\\Number">
<modifier>public</modifier> <type>BcMath\Number</type><methodname>BcMath\Number::add</methodname>
<methodparam><type class="union"><type>BcMath\Number</type><type>string</type><type>int</type></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>
Adiciona <varname>$this</varname> e <parameter>num</parameter>.
</simpara>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>num</parameter></term>
<listitem>
<simpara>
O valor a adicionar.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>scale</parameter></term>
<listitem>
<simpara>
O parâmetro <parameter>scale</parameter> especifica explicitamente a escala para os resultados de cálculo.
Se <parameter>scale</parameter> for &null;, o resultado do cálculo será definido automaticamente.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
Retorna o resultado da adição como um novo objeto <classname>BcMath\Number</classname>.
</simpara>
<simpara>
Quando a propriedade <property>BcMath\Number::scale</property> do objeto resultante é definida automaticamente,
o maior valor de <property>BcMath\Number::scale</property> dos dois números usados para adição será usado.
</simpara>
<simpara>
Isto é, com a propriedade <property>BcMath\Number::scale</property> de dois valores <literal>2</literal>
e <literal>5</literal> respectivamente, a propriedade <property>BcMath\Number::scale</property> do resultado
será <literal>5</literal>.
</simpara>
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<para>
Este método lança uma exceção <exceptionname>ValueError</exceptionname> nos seguintes casos:
<simplelist>
<member><parameter>num</parameter> é <type>string</type> e não é uma string numérica BCMath bem formada</member>
<member><parameter>scale</parameter> está fora do intervalo válido</member>
</simplelist>
</para>
</refsect1>

<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Exemplo de <methodname>BcMath\Number::add</methodname> quando <parameter>scale</parameter> não é especificado</title>
<programlisting role="php">
<![CDATA[
<?php
$number = new BcMath\Number('1.234');
$ret1 = $number->add(new BcMath\Number('2.34567'));
$ret2 = $number->add('-3.456');
$ret3 = $number->add(7);
var_dump($number, $ret1, $ret2, $ret3);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
object(BcMath\Number)#1 (2) {
["value"]=>
string(5) "1.234"
["scale"]=>
int(3)
}
object(BcMath\Number)#3 (2) {
["value"]=>
string(7) "3.57967"
["scale"]=>
int(5)
}
object(BcMath\Number)#2 (2) {
["value"]=>
string(6) "-2.222"
["scale"]=>
int(3)
}
object(BcMath\Number)#4 (2) {
["value"]=>
string(5) "8.234"
["scale"]=>
int(3)
}
]]>
</screen>
</example>

<example>
<title>Exemplo de <methodname>BcMath\Number::add</methodname> com <parameter>scale</parameter> especificado explicitamente</title>
<programlisting role="php">
<![CDATA[
<?php
$number = new BcMath\Number('1.234');
$ret1 = $number->add(new BcMath\Number('2.34567'), 1);
$ret2 = $number->add('-3.456', 10);
$ret3 = $number->add(7, 0);
var_dump($number, $ret1, $ret2, $ret3);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
object(BcMath\Number)#1 (2) {
["value"]=>
string(5) "1.234"
["scale"]=>
int(3)
}
object(BcMath\Number)#3 (2) {
["value"]=>
string(3) "3.5"
["scale"]=>
int(1)
}
object(BcMath\Number)#2 (2) {
["value"]=>
string(13) "-2.2220000000"
["scale"]=>
int(10)
}
object(BcMath\Number)#4 (2) {
["value"]=>
string(1) "8"
["scale"]=>
int(0)
}
]]>
</screen>
</example>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>bcadd</function></member>
<member><methodname>BcMath\Number::sub</methodname></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
-->
103 changes: 103 additions & 0 deletions reference/bc/bcmath/number/ceil.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
<?xml version="1.0" encoding="utf-8"?><!-- EN-Revision: c7e83fbbbcde9f54affc09424d032c38492a3ff4 Maintainer: leonardolara Status: ready -->
<refentry xml:id="bcmath-number.ceil" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>BcMath\Number::ceil</refname>
<refpurpose>Arredonda para cima um número de precisão arbitrária</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="BcMath\\Number">
<modifier>public</modifier> <type>BcMath\Number</type><methodname>BcMath\Number::ceil</methodname>
<void/>
</methodsynopsis>
<simpara>
Retorna o próximo maior valor inteiro arredondando para cima o valor de
<varname>$this</varname> se necessário.
</simpara>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
Retorna o resultado como um novo objeto <classname>BcMath\Number</classname>.
A propriedade <property>BcMath\Number::scale</property> do resultado será sempre <literal>0</literal>.
</simpara>
</refsect1>

<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Exemplo de <methodname>BcMath\Number::ceil</methodname></title>
<programlisting role="php">
<![CDATA[
<?php
$num1 = new BcMath\Number('4.3')->ceil();
$num2 = new BcMath\Number('9.999')->ceil();
$num3 = new BcMath\Number('-3.14')->ceil();
var_dump($num1, $num2, $num3);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
object(BcMath\Number)#2 (2) {
["value"]=>
string(1) "5"
["scale"]=>
int(0)
}
object(BcMath\Number)#3 (2) {
["value"]=>
string(2) "10"
["scale"]=>
int(0)
}
object(BcMath\Number)#4 (2) {
["value"]=>
string(2) "-3"
["scale"]=>
int(0)
}
]]>
</screen>
</example>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>bcceil</function></member>
<member><methodname>BcMath\Number::floor</methodname></member>
<member><methodname>BcMath\Number::round</methodname></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
-->
Loading

0 comments on commit 170e43e

Please sign in to comment.