git.m6w6.name Git - awesomized/ext-ion/blob - docs/v0.2/ion/Decimal.html

   1 <!doctype html>
   2 <html>
   3         <head>
   4                 <meta charset="utf-8">
   5                 <title>
   6                                                         Decimal -
   7                                                 mdref
   8                 </title>
   9                 <meta property="og:title" content="ion\Decimal">
  10                 <meta name="viewport" content="width=1200, initial-scale=0.5">
  11                                         <base href="/ext-ion/v0.2/">
  12                         <meta http-equiv="Content-Location" content="/ext-ion/v0.2/ion/Decimal">
  13                         <link rel="stylesheet" href="index.css">
  14
  15                 <link rel="shortcut icon" href="/ext-ion/v0.2/favicon.ico">
  16         </head>
  17         <body>
  18                 <div class="page">
  19
  20 <div class="sidebar">
  21
  22         <div class="edit">
  23                 <a href="https://github.com/awesomized/ext-ion/edit/master/ion.stub.php">Edit</a>
  24         </div>
  25
  26
  27         <ul>
  28                 <li>&lsh; <a href="./">Home</a>
  29
  30                         <ul>
  31                                 <li>
  32
  33                                         &uarr; <a href="./ion">
  34                                                         ion
  35                                                 </a>
  36                                                 <ul>
  37                                                         <li>
  38
  39                                                         &circlearrowright; <strong><a href="./ion/Decimal">Decimal</a></strong>
  40
  41
  42                                                         <ul>
  43
  44                                                                 <li>
  45                                                                         &rdsh; <a href="./ion/Decimal/Context">Context</a>
  46
  47                                                                         <ul>
  48
  49                                                                                 <li>&rdsh; <a href="./ion/Decimal/Context/Dec128">Dec128</a>
  50                                                                                 </li>
  51
  52                                                                                 <li>&rdsh; <a href="./ion/Decimal/Context/Dec32">Dec32</a>
  53                                                                                 </li>
  54
  55                                                                                 <li>&rdsh; <a href="./ion/Decimal/Context/Dec64">Dec64</a>
  56                                                                                 </li>
  57
  58                                                                                 <li>&rdsh; <a href="./ion/Decimal/Context/DecMax">DecMax</a>
  59                                                                                 </li>
  60
  61                                                                                 <li>&rdsh; <a href="./ion/Decimal/Context/Rounding">Rounding</a>
  62                                                                                 </li>
  63
  64                                                                         </ul>
  65
  66                                                                 </li>
  67
  68                                                                 <li>
  69                                                                         &rdsh; <a href="./ion/Decimal/__construct">Decimal::__construct</a>
  70
  71                                                                 </li>
  72
  73                                                                 <li>
  74                                                                         &rdsh; <a href="./ion/Decimal/equals">Decimal::equals</a>
  75
  76                                                                 </li>
  77
  78                                                                 <li>
  79                                                                         &rdsh; <a href="./ion/Decimal/isInt">Decimal::isInt</a>
  80
  81                                                                 </li>
  82
  83                                                                 <li>
  84                                                                         &rdsh; <a href="./ion/Decimal/toInt">Decimal::toInt</a>
  85
  86                                                                 </li>
  87
  88                                                                 <li>
  89                                                                         &rdsh; <a href="./ion/Decimal/toString">Decimal::toString</a>
  90
  91                                                                 </li>
  92
  93                                                         </ul>
  94
  95
  96                                                 </ul>
  97
  98                                                 <li>&ldsh; <a href="./ion/: Contributing">★ Contributing</a></li>
  99
 100                                                 <li>&ldsh; <a href="./ion/: Security">★ Security</a></li>
 101
 102                                                 <li>&ldsh; <a href="./ion/: Tutorial">★ Tutorial</a></li>
 103
 104                                                 <li>&ldsh; <a href="./ion/Catalog">Catalog</a></li>
 105
 106                                                 <li>&ldsh; <a href="./ion/Exception">Exception</a></li>
 107
 108                                                 <li>&ldsh; <a href="./ion/LOB">LOB</a></li>
 109
 110                                                 <li>&ldsh; <a href="./ion/Reader">Reader</a></li>
 111
 112                                                 <li>&ldsh; <a href="./ion/Serializer">Serializer</a></li>
 113
 114                                                 <li>&ldsh; <a href="./ion/Symbol">Symbol</a></li>
 115
 116                                                 <li>&ldsh; <a href="./ion/Timestamp">Timestamp</a></li>
 117
 118                                                 <li>&ldsh; <a href="./ion/Type">Type</a></li>
 119
 120                                                 <li>&ldsh; <a href="./ion/Unserializer">Unserializer</a></li>
 121
 122                                                 <li>&ldsh; <a href="./ion/Writer">Writer</a></li>
 123
 124                                                 <li>&ldsh; <a href="./ion/serialize">serialize</a></li>
 125
 126                                                 <li>&ldsh; <a href="./ion/unserialize">unserialize</a></li>
 127
 128                                 </li>
 129                         </ul>
 130
 131                 </li>
 132         </ul>
 133 </div>
 134                                         <meta charset="utf-8"><h1>
 135 <a class="permalink" href="ion/Decimal#">#</a><em>class</em> <a href="ion/Decimal">ion\Decimal</a> <br>&nbsp;<em>implements</em> <code><a href="https://php.net/manual/en/class.stringable">Stringable</a></code>
 136 </h1><p>An arbitrary precision fixed point decimal.</p><p>See also <a href="ion/Decimal/Context">\ion\Decimal\Context</a>, and <a href="https://amzn.github.io/ion-docs/docs/decimal.html">the ION spec's decimal docs</a>.</p><h2 id="Constants:">Constants:<a class="permalink" href="ion/Decimal#Constants:">#</a>
 137 </h2><p>None.</p><h2 id="Properties:">Properties:<a class="permalink" href="ion/Decimal#Properties:">#</a>
 138 </h2><ul>
 139 <li>
 140 <em>public</em> <code><a href="https://php.net/manual/en/language.types.string">string</a></code>|<code><a href="https://php.net/manual/en/language.types.integer">int</a></code> <span class="var" id="$number">$number<a class="permalink" href="ion/Decimal#%24number">#</a></span><br>
 141 The decimal number.</li>
 142 <li>
 143 <em>public</em> ?<a href="ion/Decimal/Context">ion\Decimal\Context</a> <span class="var" id="$context">$context<a class="permalink" href="ion/Decimal#%24context">#</a></span> = <code><a href="https://php.net/manual/en/language.types.null">NULL</a></code><br>
 144 The decimal context.</li>
 145 </ul><h2 id="Functions:">Functions:<a class="permalink" href="ion/Decimal#Functions:">#</a>
 146 </h2><ul class="sub-entries sub-functions">
 147
 148         <li>
 149                 <h3 id="Decimal::__construct">
 150 <a href="ion/Decimal/__construct">Decimal::__construct</a><a class="permalink" href="ion/Decimal#Decimal::__construct">#</a>
 151 </h3>
 152                 <p>Create a new fixed point decimal.</p>
 153
 154                 <p><code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.void">void</a></code> <a href="ion/Decimal/__construct">ion\Decimal::__construct</a>(<code><a href="https://php.net/manual/en/language.types.string">string</a></code>|<code><a href="https://php.net/manual/en/language.types.integer">int</a></code> <span class="var">$number</span>, [?<a href="ion/Decimal/Context">ion\Decimal\Context</a> <span class="var">$context</span> = <code><a href="https://php.net/manual/en/language.types.null">NULL</a></code>])</p>
 155         </li>
 156
 157         <li>
 158                 <h3 id="Decimal::equals">
 159 <a href="ion/Decimal/equals">Decimal::equals</a><a class="permalink" href="ion/Decimal#Decimal::equals">#</a>
 160 </h3>
 161                 <p>Check two decimals for equality.</p>
 162
 163                 <p><code><a href="https://php.net/manual/en/language.types.boolean">bool</a></code> <a href="ion/Decimal/equals">ion\Decimal::equals</a>(<a href="ion/Decimal">ion\Decimal</a> <span class="var">$decimal</span>)</p>
 164         </li>
 165
 166         <li>
 167                 <h3 id="Decimal::isInt">
 168 <a href="ion/Decimal/isInt">Decimal::isInt</a><a class="permalink" href="ion/Decimal#Decimal::isInt">#</a>
 169 </h3>
 170                 <p>Check whether the decimal is actually a big <code><a href="https://php.net/manual/en/language.types.integer">integer</a></code>.</p>
 171
 172                 <p><code><a href="https://php.net/manual/en/language.types.boolean">bool</a></code> <a href="ion/Decimal/isInt">ion\Decimal::isInt</a>()</p>
 173         </li>
 174
 175         <li>
 176                 <h3 id="Decimal::toInt">
 177 <a href="ion/Decimal/toInt">Decimal::toInt</a><a class="permalink" href="ion/Decimal#Decimal::toInt">#</a>
 178 </h3>
 179                 <p>Get the <code><a href="https://php.net/manual/en/language.types.integer">integer</a></code> represention of the decimal.</p>
 180
 181                 <p><code><a href="https://php.net/manual/en/language.types.integer">int</a></code> <a href="ion/Decimal/toInt">ion\Decimal::toInt</a>()</p>
 182         </li>
 183
 184         <li>
 185                 <h3 id="Decimal::toString">
 186 <a href="ion/Decimal/toString">Decimal::toString</a><a class="permalink" href="ion/Decimal#Decimal::toString">#</a>
 187 </h3>
 188                 <p>Get the <code><a href="https://php.net/manual/en/language.types.string">string</a></code> representation of the decimal.</p>
 189
 190                 <p><code><a href="https://php.net/manual/en/language.types.string">string</a></code> <a href="ion/Decimal/toString">ion\Decimal::toString</a>()</p>
 191         </li>
 192
 193 </ul><h2 id="Namespaces.Interfaces.and.Classes:">Namespaces, Interfaces and Classes:<a class="permalink" href="ion/Decimal#Namespaces.Interfaces.and.Classes:">#</a>
 194 </h2><ul class="sub-entries sub-ns-classes">
 195
 196         <li>
 197                 <h3 id="Context">
 198 <a href="ion/Decimal/Context">Context</a><a class="permalink" href="ion/Decimal#Context">#</a>
 199 </h3>
 200                 <p>An <a href="ion/Decimal">ion\Decimal</a>'s context.</p>
 201
 202                 <p><em>class</em> <a href="ion/Decimal/Context">ion\Decimal\Context</a></p>
 203         </li>
 204
 205 </ul>
 206                         <div class="comments">
 207                                                                                 <style>.giscus-frame {min-height: 16em;}</style>
 208         <script>
 209                 function giscus_load(button) {
 210                         let script = document.createElement("script");
 211                                                 script.setAttribute("data-repo", 'awesomized/ext-ion');
 212                                                 script.setAttribute("data-category", 'Comments on Docs');
 213                                                 script.setAttribute("data-repo-id", 'R_kgDOGfXEXw');
 214                                                 script.setAttribute("data-category-id", 'DIC_kwDOGfXEX84CBHuf');
 215                                                 script.setAttribute("data-mapping", 'og:title');
 216                                                 script.setAttribute("data-input-position", 'bottom');
 217                                                 script.setAttribute("data-reactions-enabled", false);
 218                                                 script.setAttribute("data-theme", 'light');
 219                                                 script.setAttribute("data-lang", 'en');
 220
 221                         script.src = "//giscus.app/client.js";
 222                         button.parentNode.replaceChild(script, button);
 223                 }
 224         </script>
 225         <button class="activator" onclick="giscus_load(this)">Show Comments from Github Discussions</button>
 226
 227                         </div>
 228
 229                         <footer>
 230
 231 <ul>
 232         <li><a href="https://github.com/m6w6/mdref">mdref-v3.0
 233 </a></li>
 234         <li><a href="LICENSE">&copy; 2013-2022          All rights reserved.</a></li>
 235         <li>
 236 </li>
 237 </ul>
 238
 239                         </footer>
 240
 241                         <script src="index.js" defer></script>
 242
 243                 </div>
 244         </body>
 245 </html>