ext/bcmath: BcMath\Number class

language-snippets.ent

@@ -2155,11 +2155,6 @@ of digits after the decimal place in the result. If omitted, it will default to
 globally with the <function>bcscale</function> function, or fallback to <literal>0</literal> if
 this has not been set.</para></listitem></varlistentry>'>
 
-<!ENTITY bc.number.scale.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term>
-<parameter>scale</parameter></term><listitem><simpara><parameter>scale</parameter> explicitly
-specified for calculation results. If &null;, the <parameter>scale</parameter> of the calculation
-result will be set automatically.</simpara></listitem></varlistentry>'>
-
 <!-- CTYPE Notes -->
 <!ENTITY note.ctype.parameter.integer '<note xmlns="http://docbook.org/ns/docbook"><para>
 If an <type>int</type> between -128 and 255 inclusive is provided, it is interpreted as

reference/bc/bcmath/number/add.xml

@@ -28,7 +28,15 @@
      </simpara>
     </listitem>
    </varlistentry>
-   &bc.number.scale.description;
+   <varlistentry>
+    <term><parameter>scale</parameter></term>
+    <listitem>
+     <simpara>
+      <parameter>scale</parameter> explicitly specified for calculation results.
+      If &null;, the <parameter>scale</parameter> of the calculation result will be set automatically.
+     </simpara>
+    </listitem>
+   </varlistentry>
   </variablelist>
  </refsect1>
 

reference/bc/bcmath/number/compare.xml

@@ -14,7 +14,7 @@
   </methodsynopsis>
   <simpara>
    Compare two arbitrary precision numbers.
-   This method behaves similar to the spaceship operator.
+   This method behaves similar to the <link linkend="language.operators.comparison">spaceship operator</link>.
   </simpara>
  </refsect1>
 

reference/bc/bcmath/number/div.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<refentry xml:id="bcmath-number.div" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xml:id="bcmath-number.div" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
  <refnamediv>
   <refname>BcMath\Number::div</refname>
   <refpurpose>Divides by an arbitrary precision number</refpurpose>
@@ -28,7 +28,7 @@
      </simpara>
     </listitem>
    </varlistentry>
-   &bc.number.scale.description;
+   <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('bcmath-number.add')/db:refsect1[@role='parameters']/descendant::db:varlistentry[2])" />
   </variablelist>
  </refsect1>
 
@@ -50,49 +50,13 @@
   </simpara>
   <simpara>
     Even in indivisible calculations, the <property>BcMath\Number::scale</property> will not always be
-    +<literal>10</literal>.
+    <literal>+10</literal>.
     A <literal>0</literal> at the end of the result is considered not to need expansion, so the
     <property>BcMath\Number::scale</property> is reduced by that amount.
     The <property>BcMath\Number::scale</property> will never be less than the
     <property>BcMath\Number::scale</property> before expansion.
+    See also the <link linkend="bcmath-number.div.example.expansion-scale">code example</link>.
   </simpara>
-  <example>
-   <title>Example of <property>BcMath\Number::scale</property> of result object</title>
-   <programlisting role="php">
-<![CDATA[
-<?php
-var_dump(
-    new BcMath\Number('0.001')->div('10001'),
-    new BcMath\Number('0.001')->div('10001', 13),
-    new BcMath\Number('0.001')->div('100000000000001'),
-);
-?>
-]]>
-   </programlisting>
-   &example.outputs;
-   <screen>
-<![CDATA[
-object(BcMath\Number)#2 (2) {
-  ["value"]=>
-  string(13) "0.00000009999"
-  ["scale"]=>
-  int(11)
-}
-object(BcMath\Number)#3 (2) {
-  ["value"]=>
-  string(15) "0.0000000999900"
-  ["scale"]=>
-  int(13)
-}
-object(BcMath\Number)#4 (2) {
-  ["value"]=>
-  string(5) "0.000"
-  ["scale"]=>
-  int(3)
-}
-]]>
-   </screen>
-  </example>
  </refsect1>
 
  <refsect1 role="errors">
@@ -201,6 +165,44 @@ object(BcMath\Number)#4 (2) {
   ["scale"]=>
   int(2)
 }
+]]>
+   </screen>
+  </example>
+
+  <example xml:id="bcmath-number.div.example.expansion-scale">
+   <title><methodname>BcMath\Number::div</methodname> example of expansioning <property>BcMath\Number::scale</property> of result object</title>
+   <programlisting role="php">
+<![CDATA[
+<?php
+var_dump(
+    new BcMath\Number('0.001')->div('10001'),
+    new BcMath\Number('0.001')->div('10001', 13),
+    new BcMath\Number('0.001')->div('100000000000001'),
+);
+?>
+]]>
+   </programlisting>
+   &example.outputs;
+   <screen>
+<![CDATA[
+object(BcMath\Number)#2 (2) {
+  ["value"]=>
+  string(13) "0.00000009999"
+  ["scale"]=>
+  int(11)
+}
+object(BcMath\Number)#3 (2) {
+  ["value"]=>
+  string(15) "0.0000000999900"
+  ["scale"]=>
+  int(13)
+}
+object(BcMath\Number)#4 (2) {
+  ["value"]=>
+  string(5) "0.000"
+  ["scale"]=>
+  int(3)
+}
 ]]>
    </screen>
   </example>

reference/bc/bcmath/number/mul.xml

@@ -28,7 +28,7 @@
      </simpara>
     </listitem>
    </varlistentry>
-   &bc.number.scale.description;
+   <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('bcmath-number.add')/db:refsect1[@role='parameters']/descendant::db:varlistentry[2])" />
   </variablelist>
  </refsect1>
 

reference/bc/bcmath/number/pow.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<refentry xml:id="bcmath-number.pow" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xml:id="bcmath-number.pow" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
  <refnamediv>
   <refname>BcMath\Number::pow</refname>
   <refpurpose>Raises an arbitrary precision number</refpurpose>
@@ -30,7 +30,7 @@
      </simpara>
     </listitem>
    </varlistentry>
-   &bc.number.scale.description;
+   <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('bcmath-number.add')/db:refsect1[@role='parameters']/descendant::db:varlistentry[2])" />
   </variablelist>
  </refsect1>
 
@@ -72,7 +72,7 @@
   <simpara>
    If an indivisible division occurs due to a negative <parameter>exponent</parameter>, the <property>
    BcMath\Number::scale</property> of the result is expanded. Expansion is done only as needed, up to
-   a maximum of +<literal>10</literal>.
+   a maximum of <literal>+10</literal>.
    This behavior is the same as <methodname>BcMath\Number::div</methodname>, so please see that for details.
   </simpara>
  </refsect1>

reference/bc/bcmath/number/powmod.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<refentry xml:id="bcmath-number.powmod" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xml:id="bcmath-number.powmod" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
  <refnamediv>
   <refname>BcMath\Number::powmod</refname>
   <refpurpose>Raises an arbitrary precision number, reduced by a specified modulus</refpurpose>
@@ -38,7 +38,7 @@
      </simpara>
     </listitem>
    </varlistentry>
-   &bc.number.scale.description;
+   <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('bcmath-number.add')/db:refsect1[@role='parameters']/descendant::db:varlistentry[2])" />
   </variablelist>
  </refsect1>
 

reference/bc/bcmath/number/sqrt.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<refentry xml:id="bcmath-number.sqrt" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xml:id="bcmath-number.sqrt" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
  <refnamediv>
   <refname>BcMath\Number::sqrt</refname>
   <refpurpose>Gets the square root of an arbitrary precision number</refpurpose>
@@ -19,7 +19,7 @@
  <refsect1 role="parameters">
   &reftitle.parameters;
   <variablelist>
-   &bc.number.scale.description;
+   <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('bcmath-number.add')/db:refsect1[@role='parameters']/descendant::db:varlistentry[2])" />
   </variablelist>
  </refsect1>
 
@@ -32,7 +32,7 @@
    When the <property>BcMath\Number::scale</property> of the result object is automatically set,
    the <property>BcMath\Number::scale</property> of this object is used. However, in cases such
    as indivisible division, the <property>BcMath\Number::scale</property> of the result is expanded.
-   Expansion is done only as needed, up to a maximum of +<literal>10</literal>.
+   Expansion is done only as needed, up to a maximum of <literal>+10</literal>.
   </simpara>
   <simpara>
    That is, if the <property>BcMath\Number::scale</property> of this object is <literal>5</literal>,

reference/bc/bcmath/number/sub.xml

@@ -28,7 +28,7 @@
      </simpara>
     </listitem>
    </varlistentry>
-   &bc.number.scale.description;
+   <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('bcmath-number.add')/db:refsect1[@role='parameters']/descendant::db:varlistentry[2])" />
   </variablelist>
  </refsect1>