git.m6w6.name Git - awesomized/ext-ion/blob - docs/v0.0/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 name="viewport" content="width=1200, initial-scale=0.5">
  10                                         <base href="/v0.0/">
  11                         <meta http-equiv="Content-Location" content="/v0.0/ion/Decimal">
  12                         <link rel="stylesheet" href="index.css">
  13
  14                 <link href="https://fonts.googleapis.com/css?family=Inconsolata&amp;subset=latin-ext" rel="stylesheet">
  15                 <script src="//ajax.googleapis.com/ajax/libs/jquery/2.1.4/jquery.min.js"></script>
  16                 <link rel="shortcut icon" href="/v0.0/favicon.ico">
  17         </head>
  18         <body>
  19                 <div class="page">
  20
  21 <div class="sidebar">
  22
  23         <div class="edit">
  24                 <a href="./ion/Decimal">Edit</a>
  25         </div>
  26
  27
  28         <ul>
  29                 <li>&lsh; <a href="./">Home</a>
  30
  31                         <ul>
  32                                 <li>
  33
  34                                         &uarr; <a href="./ion">
  35                                                         ion
  36                                                 </a>
  37                                                 <ul>
  38                                                         <li>
  39
  40                                                         &circlearrowright; <strong><a href="./ion/Decimal">Decimal</a></strong>
  41
  42
  43                                                         <ul>
  44
  45                                                                 <li>
  46                                                                         &rdsh; <a href="./ion/Decimal/Context">Context</a>
  47
  48                                                                         <ul>
  49
  50                                                                                 <li>&rdsh; <a href="./ion/Decimal/Context/Dec128">Dec128</a>
  51                                                                                 </li>
  52
  53                                                                                 <li>&rdsh; <a href="./ion/Decimal/Context/Dec32">Dec32</a>
  54                                                                                 </li>
  55
  56                                                                                 <li>&rdsh; <a href="./ion/Decimal/Context/Dec64">Dec64</a>
  57                                                                                 </li>
  58
  59                                                                                 <li>&rdsh; <a href="./ion/Decimal/Context/DecMax">DecMax</a>
  60                                                                                 </li>
  61
  62                                                                                 <li>&rdsh; <a href="./ion/Decimal/Context/Rounding">Rounding</a>
  63                                                                                 </li>
  64
  65                                                                         </ul>
  66
  67                                                                 </li>
  68
  69                                                                 <li>
  70                                                                         &rdsh; <a href="./ion/Decimal/__construct">Decimal::__construct</a>
  71
  72                                                                 </li>
  73
  74                                                                 <li>
  75                                                                         &rdsh; <a href="./ion/Decimal/equals">Decimal::equals</a>
  76
  77                                                                 </li>
  78
  79                                                                 <li>
  80                                                                         &rdsh; <a href="./ion/Decimal/isInt">Decimal::isInt</a>
  81
  82                                                                 </li>
  83
  84                                                                 <li>
  85                                                                         &rdsh; <a href="./ion/Decimal/toInt">Decimal::toInt</a>
  86
  87                                                                 </li>
  88
  89                                                                 <li>
  90                                                                         &rdsh; <a href="./ion/Decimal/toString">Decimal::toString</a>
  91
  92                                                                 </li>
  93
  94                                                         </ul>
  95
  96
  97                                                 </ul>
  98
  99                                                 <li>&ldsh; <a href="./ion/: Contributing">★ Contributing</a></li>
 100
 101                                                 <li>&ldsh; <a href="./ion/: Security">★ Security</a></li>
 102
 103                                                 <li>&ldsh; <a href="./ion/Catalog">Catalog</a></li>
 104
 105                                                 <li>&ldsh; <a href="./ion/Exception">Exception</a></li>
 106
 107                                                 <li>&ldsh; <a href="./ion/LOB">LOB</a></li>
 108
 109                                                 <li>&ldsh; <a href="./ion/Reader">Reader</a></li>
 110
 111                                                 <li>&ldsh; <a href="./ion/Serializer">Serializer</a></li>
 112
 113                                                 <li>&ldsh; <a href="./ion/Symbol">Symbol</a></li>
 114
 115                                                 <li>&ldsh; <a href="./ion/Timestamp">Timestamp</a></li>
 116
 117                                                 <li>&ldsh; <a href="./ion/Type">Type</a></li>
 118
 119                                                 <li>&ldsh; <a href="./ion/Unserializer">Unserializer</a></li>
 120
 121                                                 <li>&ldsh; <a href="./ion/Writer">Writer</a></li>
 122
 123                                                 <li>&ldsh; <a href="./ion/serialize">serialize</a></li>
 124
 125                                                 <li>&ldsh; <a href="./ion/unserialize">unserialize</a></li>
 126
 127                                 </li>
 128                         </ul>
 129
 130                 </li>
 131         </ul>
 132 </div>
 133
 134 <h1>class ion\Decimal implements Stringable</h1>
 135 <p>An arbitrary precision fixed point decimal.</p>
 136 <p>See also \ion\Decimal\Context, and <a href="https://amzn.github.io/ion-docs/docs/decimal.html">the ION spec's decimal docs</a>.</p>
 137 <h2>Constants:<a id="Constants:" href="#Constants:" class="permalink" aria-hidden="true" title="">#</a></h2>
 138 <p>None.</p>
 139 <h2>Properties:<a id="Properties:" href="#Properties:" class="permalink" aria-hidden="true" title="">#</a></h2>
 140 <ul>
 141 <li>public string|int $number<br />
 142 The decimal number.</li>
 143 <li>public ?ion\Decimal\Context $context = NULL<br />
 144 The decimal context.</li>
 145 </ul>
 146
 147
 148
 149 <h2 id="Functions:">Functions:</h2>
 150 <ul>
 151
 152         <li>
 153                 <h3><a href="ion/Decimal/__construct">Decimal::__construct</a></h3>
 154                 <p>Create a new fixed point decimal.</p>
 155
 156                 <p>void ion\Decimal::__construct(string|int $number, [?ion\Decimal\Context $context = NULL])</p>
 157         </li>
 158
 159         <li>
 160                 <h3><a href="ion/Decimal/equals">Decimal::equals</a></h3>
 161                 <p>Check two decimals for equality.</p>
 162
 163                 <p>bool ion\Decimal::equals(ion\Decimal $decimal)</p>
 164         </li>
 165
 166         <li>
 167                 <h3><a href="ion/Decimal/isInt">Decimal::isInt</a></h3>
 168                 <p>Check whether the decimal is actually a big integer.</p>
 169
 170                 <p>bool ion\Decimal::isInt()</p>
 171         </li>
 172
 173         <li>
 174                 <h3><a href="ion/Decimal/toInt">Decimal::toInt</a></h3>
 175                 <p>Get the integer represention of the decimal.</p>
 176
 177                 <p>int ion\Decimal::toInt()</p>
 178         </li>
 179
 180         <li>
 181                 <h3><a href="ion/Decimal/toString">Decimal::toString</a></h3>
 182                 <p>Get the string representation of the decimal.</p>
 183
 184                 <p>string ion\Decimal::toString()</p>
 185         </li>
 186
 187 </ul>
 188
 189
 190 <h2 id="Namespaces,.Interfaces.and.Classes:">Namespaces, Interfaces and Classes:</h2>
 191 <ul>
 192
 193         <li>
 194                 <h3><a href="ion/Decimal/Context">Context</a></h3>
 195                 <p>An ion\Decimal's context.</p>
 196
 197                 <p>class ion\Decimal\Context</p>
 198         </li>
 199
 200 </ul>
 201
 202                         <div id="disqus_thread"><button id="disqus_activator">Show <span> </span> Comment(s)</button></div>
 203                         <script>
 204                                 var disqus_shortname = 'mdref';
 205                                 var disqus_identifier = 'ion/Decimal';
 206                         </script>
 207
 208                         <footer>
 209
 210 <ul>
 211         <li><a href="https://github.com/m6w6/mdref">mdref-v2.0
 212 </a></li>
 213         <li><a href="LICENSE">&copy; 2013-2022          All rights reserved.</a></li>
 214         <li>
 215 </li>
 216 </ul>
 217
 218                         </footer>
 219
 220                         <script src="index.js"></script>
 221
 222                 </div>
 223         </body>
 224 </html>