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="/ext-ion/v0.0/">
  11                         <meta http-equiv="Content-Location" content="/ext-ion/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="/ext-ion/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                                         <meta charset="utf-8"><h1>
 134 <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>
 135 </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>
 136 </h2><p>None.</p><h2 id="Properties:">Properties:<a class="permalink" href="ion/Decimal#Properties:">#</a>
 137 </h2><ul>
 138 <li>
 139 <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>
 140 The decimal number.</li>
 141 <li>
 142 <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>
 143 The decimal context.</li>
 144 </ul><h2 id="Functions:">Functions:<a class="permalink" href="ion/Decimal#Functions:">#</a>
 145 </h2><ul>
 146
 147         <li>
 148                 <h3 id="Decimal::__construct">
 149 <a href="ion/Decimal/__construct">Decimal::__construct</a><a class="permalink" href="ion/Decimal#Decimal::__construct">#</a>
 150 </h3>
 151                 <p>Create a new fixed point decimal.</p>
 152
 153                 <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>
 154         </li>
 155
 156         <li>
 157                 <h3 id="Decimal::equals">
 158 <a href="ion/Decimal/equals">Decimal::equals</a><a class="permalink" href="ion/Decimal#Decimal::equals">#</a>
 159 </h3>
 160                 <p>Check two decimals for equality.</p>
 161
 162                 <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>
 163         </li>
 164
 165         <li>
 166                 <h3 id="Decimal::isInt">
 167 <a href="ion/Decimal/isInt">Decimal::isInt</a><a class="permalink" href="ion/Decimal#Decimal::isInt">#</a>
 168 </h3>
 169                 <p>Check whether the decimal is actually a big <code><a href="https://php.net/manual/en/language.types.integer">integer</a></code>.</p>
 170
 171                 <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>
 172         </li>
 173
 174         <li>
 175                 <h3 id="Decimal::toInt">
 176 <a href="ion/Decimal/toInt">Decimal::toInt</a><a class="permalink" href="ion/Decimal#Decimal::toInt">#</a>
 177 </h3>
 178                 <p>Get the <code><a href="https://php.net/manual/en/language.types.integer">integer</a></code> represention of the decimal.</p>
 179
 180                 <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>
 181         </li>
 182
 183         <li>
 184                 <h3 id="Decimal::toString">
 185 <a href="ion/Decimal/toString">Decimal::toString</a><a class="permalink" href="ion/Decimal#Decimal::toString">#</a>
 186 </h3>
 187                 <p>Get the <code><a href="https://php.net/manual/en/language.types.string">string</a></code> representation of the decimal.</p>
 188
 189                 <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>
 190         </li>
 191
 192 </ul><h2 id="Namespaces.Interfaces.and.Classes:">Namespaces, Interfaces and Classes:<a class="permalink" href="ion/Decimal#Namespaces.Interfaces.and.Classes:">#</a>
 193 </h2><ul>
 194
 195         <li>
 196                 <h3 id="Context">
 197 <a href="ion/Decimal/Context">Context</a><a class="permalink" href="ion/Decimal#Context">#</a>
 198 </h3>
 199                 <p>An <a href="ion/Decimal">ion\Decimal</a>'s context.</p>
 200
 201                 <p><em>class</em> <a href="ion/Decimal/Context">ion\Decimal\Context</a></p>
 202         </li>
 203
 204 </ul>
 205                         <div id="disqus_thread"><button id="disqus_activator">Show <span> </span> Comment(s)</button></div>
 206                         <script>
 207                                 var disqus_shortname = 'mdref';
 208                                 var disqus_identifier = 'ion/Decimal';
 209                         </script>
 210
 211                         <footer>
 212
 213 <ul>
 214         <li><a href="https://github.com/m6w6/mdref">mdref-v3.0
 215 </a></li>
 216         <li><a href="LICENSE">&copy; 2013-2022          All rights reserved.</a></li>
 217         <li>
 218 </li>
 219 </ul>
 220
 221                         </footer>
 222
 223                         <script src="index.js"></script>
 224
 225                 </div>
 226         </body>
 227 </html>