|
| 1 | +<?xml version="1.0" encoding="utf-8"?> |
| 2 | +<!-- $Revision$ --> |
| 3 | +<!-- EN-Revision: a414ee95eb79e2c62c80827a46e15da5d15af97e Maintainer: saki Status: ready --> |
| 4 | + |
| 5 | +<refentry xml:id="bcmath-number.add" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> |
| 6 | + <refnamediv> |
| 7 | + <refname>BcMath\Number::add</refname> |
| 8 | + <refpurpose>任意精度の数値を加算する</refpurpose> |
| 9 | + </refnamediv> |
| 10 | + |
| 11 | + <refsect1 role="description"> |
| 12 | + &reftitle.description; |
| 13 | + <methodsynopsis role="BcMath\\Number"> |
| 14 | + <modifier>public</modifier> <type>BcMath\Number</type><methodname>BcMath\Number::add</methodname> |
| 15 | + <methodparam><type class="union"><type>BcMath\Number</type><type>string</type><type>int</type></type><parameter>num</parameter></methodparam> |
| 16 | + <methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>scale</parameter><initializer>&null;</initializer></methodparam> |
| 17 | + </methodsynopsis> |
| 18 | + <simpara> |
| 19 | + <varname>$this</varname> と <parameter>num</parameter> を加算します。 |
| 20 | + </simpara> |
| 21 | + </refsect1> |
| 22 | + |
| 23 | + <refsect1 role="parameters"> |
| 24 | + &reftitle.parameters; |
| 25 | + <variablelist> |
| 26 | + <varlistentry> |
| 27 | + <term><parameter>num</parameter></term> |
| 28 | + <listitem> |
| 29 | + <simpara> |
| 30 | + 加数を表す値。 |
| 31 | + </simpara> |
| 32 | + </listitem> |
| 33 | + </varlistentry> |
| 34 | + <varlistentry> |
| 35 | + <term><parameter>scale</parameter></term> |
| 36 | + <listitem> |
| 37 | + <simpara> |
| 38 | + 計算結果オブジェクトの <property>BcMath\Number::scale</property> を明示的に指定します。 |
| 39 | + &null; の場合、計算結果の <property>BcMath\Number::scale</property> は自動的に設定されます。 |
| 40 | + </simpara> |
| 41 | + </listitem> |
| 42 | + </varlistentry> |
| 43 | + </variablelist> |
| 44 | + </refsect1> |
| 45 | + |
| 46 | + <refsect1 role="returnvalues"> |
| 47 | + &reftitle.returnvalues; |
| 48 | + <simpara> |
| 49 | + 加算結果を新しい <classname>BcMath\Number</classname> オブジェクトとして返します。 |
| 50 | + </simpara> |
| 51 | + <simpara> |
| 52 | + 加算結果オブジェクトの <property>BcMath\Number::scale</property> が自動的に設定される場合、加算に使用する2つの数値のうち、 |
| 53 | + 大きい方の <property>BcMath\Number::scale</property> が使用されます。 |
| 54 | + </simpara> |
| 55 | + <simpara> |
| 56 | + つまり、2つの値の <property>BcMath\Number::scale</property> がそれぞれ <literal>2</literal> と <literal>5</literal> の場合、 |
| 57 | + 加算結果オブジェクトの <property>BcMath\Number::scale</property> は <literal>5</literal> になります。 |
| 58 | + </simpara> |
| 59 | + </refsect1> |
| 60 | + |
| 61 | + <refsect1 role="errors"> |
| 62 | + &reftitle.errors; |
| 63 | + <para> |
| 64 | + このメソッドは、以下の場合に <classname>ValueError</classname> をスローします: |
| 65 | + <simplelist> |
| 66 | + <member><parameter>num</parameter> が、BCMath で有効でない数値形式の文字列である場合</member> |
| 67 | + <member><parameter>scale</parameter> が範囲外の値である場合</member> |
| 68 | + </simplelist> |
| 69 | + </para> |
| 70 | + </refsect1> |
| 71 | + |
| 72 | + <refsect1 role="examples"> |
| 73 | + &reftitle.examples; |
| 74 | + <example> |
| 75 | + <title><methodname>BcMath\Number::add</methodname> で <parameter>scale</parameter> を指定しない例</title> |
| 76 | + <programlisting role="php"> |
| 77 | +<![CDATA[ |
| 78 | +<?php |
| 79 | +$number = new BcMath\Number('1.234'); |
| 80 | +
|
| 81 | +$ret1 = $number->add(new BcMath\Number('2.34567')); |
| 82 | +$ret2 = $number->add('-3.456'); |
| 83 | +$ret3 = $number->add(7); |
| 84 | +
|
| 85 | +var_dump($number, $ret1, $ret2, $ret3); |
| 86 | +?> |
| 87 | +]]> |
| 88 | + </programlisting> |
| 89 | + &example.outputs; |
| 90 | + <screen> |
| 91 | +<![CDATA[ |
| 92 | +object(BcMath\Number)#1 (2) { |
| 93 | + ["value"]=> |
| 94 | + string(5) "1.234" |
| 95 | + ["scale"]=> |
| 96 | + int(3) |
| 97 | +} |
| 98 | +object(BcMath\Number)#3 (2) { |
| 99 | + ["value"]=> |
| 100 | + string(7) "3.57967" |
| 101 | + ["scale"]=> |
| 102 | + int(5) |
| 103 | +} |
| 104 | +object(BcMath\Number)#2 (2) { |
| 105 | + ["value"]=> |
| 106 | + string(6) "-2.222" |
| 107 | + ["scale"]=> |
| 108 | + int(3) |
| 109 | +} |
| 110 | +object(BcMath\Number)#4 (2) { |
| 111 | + ["value"]=> |
| 112 | + string(5) "8.234" |
| 113 | + ["scale"]=> |
| 114 | + int(3) |
| 115 | +} |
| 116 | +]]> |
| 117 | + </screen> |
| 118 | + </example> |
| 119 | + |
| 120 | + <example> |
| 121 | + <title><methodname>BcMath\Number::add</methodname> で <parameter>scale</parameter> を指定する例</title> |
| 122 | + <programlisting role="php"> |
| 123 | +<![CDATA[ |
| 124 | +<?php |
| 125 | +$number = new BcMath\Number('1.234'); |
| 126 | +
|
| 127 | +$ret1 = $number->add(new BcMath\Number('2.34567'), 1); |
| 128 | +$ret2 = $number->add('-3.456', 10); |
| 129 | +$ret3 = $number->add(7, 0); |
| 130 | +
|
| 131 | +var_dump($number, $ret1, $ret2, $ret3); |
| 132 | +?> |
| 133 | +]]> |
| 134 | + </programlisting> |
| 135 | + &example.outputs; |
| 136 | + <screen> |
| 137 | +<![CDATA[ |
| 138 | +object(BcMath\Number)#1 (2) { |
| 139 | + ["value"]=> |
| 140 | + string(5) "1.234" |
| 141 | + ["scale"]=> |
| 142 | + int(3) |
| 143 | +} |
| 144 | +object(BcMath\Number)#3 (2) { |
| 145 | + ["value"]=> |
| 146 | + string(3) "3.5" |
| 147 | + ["scale"]=> |
| 148 | + int(1) |
| 149 | +} |
| 150 | +object(BcMath\Number)#2 (2) { |
| 151 | + ["value"]=> |
| 152 | + string(13) "-2.2220000000" |
| 153 | + ["scale"]=> |
| 154 | + int(10) |
| 155 | +} |
| 156 | +object(BcMath\Number)#4 (2) { |
| 157 | + ["value"]=> |
| 158 | + string(1) "8" |
| 159 | + ["scale"]=> |
| 160 | + int(0) |
| 161 | +} |
| 162 | +]]> |
| 163 | + </screen> |
| 164 | + </example> |
| 165 | + </refsect1> |
| 166 | + |
| 167 | + <refsect1 role="seealso"> |
| 168 | + &reftitle.seealso; |
| 169 | + <simplelist> |
| 170 | + <member><function>bcadd</function></member> |
| 171 | + <member><methodname>BcMath\Number::sub</methodname></member> |
| 172 | + </simplelist> |
| 173 | + </refsect1> |
| 174 | + |
| 175 | +</refentry> |
| 176 | +<!-- Keep this comment at the end of the file |
| 177 | +Local variables: |
| 178 | +mode: sgml |
| 179 | +sgml-omittag:t |
| 180 | +sgml-shorttag:t |
| 181 | +sgml-minimize-attributes:nil |
| 182 | +sgml-always-quote-attributes:t |
| 183 | +sgml-indent-step:1 |
| 184 | +sgml-indent-data:t |
| 185 | +indent-tabs-mode:nil |
| 186 | +sgml-parent-document:nil |
| 187 | +sgml-default-dtd-file:"~/.phpdoc/manual.ced" |
| 188 | +sgml-exposed-tags:nil |
| 189 | +sgml-local-catalogs:nil |
| 190 | +sgml-local-ecat-files:nil |
| 191 | +End: |
| 192 | +vim600: syn=xml fen fdm=syntax fdl=2 si |
| 193 | +vim: et tw=78 syn=sgml |
| 194 | +vi: ts=1 sw=1 |
| 195 | +--> |
0 commit comments