Created ceil()

Author: SakiTakamachi

reference/bc/bcmath/number/ceil.xml

@@ -0,0 +1,102 @@
+<?xml version="1.0" encoding="utf-8"?>
+<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>Rounds up an arbitrary precision number</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>
+   Returns the next highest integer value by rounding up
+   this object if necessary.
+  </simpara>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;</refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <simpara>
+   Returns the result as a new <classname>BcMath\Number</classname> object.
+   The <property>BcMath\Number::scale</property> of the result is always <literal>0</literal>.
+  </simpara>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <example>
+   <title><methodname>BcMath\Number::ceil</methodname> example</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
+-->

reference/bc/functions/bcceil.xml

@@ -68,6 +68,7 @@ string(2) "-3"
   <simplelist>
    <member><function>bcfloor</function></member>
    <member><function>bcround</function></member>
+   <member><methodname>BcMath\Number::ceil</methodname></member>
   </simplelist>
  </refsect1>
 </refentry>