docs: update
[awesomized/ext-ion] / docs / v0.0 / ion / Decimal / Context.html
1 <!doctype html>
2 <html>
3 <head>
4 <meta charset="utf-8">
5 <title>
6 Context -
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/Context">
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/Context">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 &uarr; <a href="./ion/Decimal">
41 Decimal
42 </a>
43 <ul>
44 <li>
45
46 &circlearrowright; <strong><a href="./ion/Decimal/Context">Context</a></strong>
47
48
49 <ul>
50
51 <li>
52 &rdsh; <a href="./ion/Decimal/Context/Dec128">Dec128</a>
53
54 </li>
55
56 <li>
57 &rdsh; <a href="./ion/Decimal/Context/Dec32">Dec32</a>
58
59 </li>
60
61 <li>
62 &rdsh; <a href="./ion/Decimal/Context/Dec64">Dec64</a>
63
64 </li>
65
66 <li>
67 &rdsh; <a href="./ion/Decimal/Context/DecMax">DecMax</a>
68
69 </li>
70
71 <li>
72 &rdsh; <a href="./ion/Decimal/Context/Rounding">Rounding</a>
73
74 </li>
75
76 <li>
77 &rdsh; <a href="./ion/Decimal/Context/__construct">Context::__construct</a>
78
79 </li>
80
81 </ul>
82
83
84 </ul>
85
86 <li>&ldsh; <a href="./ion/Decimal/__construct">Decimal::__construct</a></li>
87
88 <li>&ldsh; <a href="./ion/Decimal/equals">Decimal::equals</a></li>
89
90 <li>&ldsh; <a href="./ion/Decimal/isInt">Decimal::isInt</a></li>
91
92 <li>&ldsh; <a href="./ion/Decimal/toInt">Decimal::toInt</a></li>
93
94 <li>&ldsh; <a href="./ion/Decimal/toString">Decimal::toString</a></li>
95
96 </ul>
97
98 </li>
99 </ul>
100
101 </li>
102 </ul>
103 </div>
104 <meta charset="utf-8"><h1>
105 <a class="permalink" href="ion/Decimal/Context#">#</a><em>class</em> <a href="ion/Decimal/Context">ion\Decimal\Context</a>
106 </h1><p>An <a href="ion/Decimal">ion\Decimal</a>'s context.</p><h2 id="Constants:">Constants:<a class="permalink" href="ion/Decimal/Context#Constants:">#</a>
107 </h2><p>None.</p><h2 id="Properties:">Properties:<a class="permalink" href="ion/Decimal/Context#Properties:">#</a>
108 </h2><ul>
109 <li>
110 <em>public</em> <code><a href="https://php.net/manual/en/language.types.integer">int</a></code> <span class="var" id="$digits">$digits<a class="permalink" href="ion/Decimal/Context#%24digits">#</a></span><br>
111 Maximum digits.</li>
112 <li>
113 <em>public</em> <code><a href="https://php.net/manual/en/language.types.integer">int</a></code> <span class="var" id="$eMax">$eMax<a class="permalink" href="ion/Decimal/Context#%24eMax">#</a></span><br>
114 Maximum exponent.</li>
115 <li>
116 <em>public</em> <code><a href="https://php.net/manual/en/language.types.integer">int</a></code> <span class="var" id="$eMin">$eMin<a class="permalink" href="ion/Decimal/Context#%24eMin">#</a></span><br>
117 Minimum exponent.</li>
118 <li>
119 <em>public</em> <a href="ion/Decimal/Context/Rounding">ion\Decimal\Context\Rounding</a>|<code><a href="https://php.net/manual/en/language.types.integer">int</a></code> <span class="var" id="$round">$round<a class="permalink" href="ion/Decimal/Context#%24round">#</a></span><br>
120 Rounding mode.</li>
121 <li>
122 <em>public</em> <code><a href="https://php.net/manual/en/language.types.boolean">bool</a></code> <span class="var" id="$clamp">$clamp<a class="permalink" href="ion/Decimal/Context#%24clamp">#</a></span><br>
123 Whether to clamp.</li>
124 </ul><h2 id="Functions:">Functions:<a class="permalink" href="ion/Decimal/Context#Functions:">#</a>
125 </h2><ul>
126
127 <li>
128 <h3 id="Context::__construct">
129 <a href="ion/Decimal/Context/__construct">Context::__construct</a><a class="permalink" href="ion/Decimal/Context#Context::__construct">#</a>
130 </h3>
131 <p>Create a new decimal context.</p>
132
133 <p><code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.void">void</a></code> <a href="ion/Decimal/Context/__construct">ion\Decimal\Context::__construct</a>(<code><a href="https://php.net/manual/en/language.types.integer">int</a></code> <span class="var">$digits</span>, <code><a href="https://php.net/manual/en/language.types.integer">int</a></code> <span class="var">$eMax</span>, <code><a href="https://php.net/manual/en/language.types.integer">int</a></code> <span class="var">$eMin</span>, <a href="ion/Decimal/Context/Rounding">ion\Decimal\Context\Rounding</a>|<code><a href="https://php.net/manual/en/language.types.integer">int</a></code> <span class="var">$round</span>, <code><a href="https://php.net/manual/en/language.types.boolean">bool</a></code> <span class="var">$clamp</span>)</p>
134 </li>
135
136 </ul><h2 id="Namespaces.Interfaces.and.Classes:">Namespaces, Interfaces and Classes:<a class="permalink" href="ion/Decimal/Context#Namespaces.Interfaces.and.Classes:">#</a>
137 </h2><ul>
138
139 <li>
140 <h3 id="Dec128">
141 <a href="ion/Decimal/Context/Dec128">Dec128</a><a class="permalink" href="ion/Decimal/Context#Dec128">#</a>
142 </h3>
143 <p>Create a context suitable for 128bit decimals.</p>
144
145 <p><em>static</em> <a href="ion/Decimal/Context">ion\Decimal\Context</a> <a href="ion/Decimal/Context/Dec128">ion\Decimal\Context::Dec128</a>()</p>
146 </li>
147
148 <li>
149 <h3 id="Dec32">
150 <a href="ion/Decimal/Context/Dec32">Dec32</a><a class="permalink" href="ion/Decimal/Context#Dec32">#</a>
151 </h3>
152 <p>Create a context suitable for 32bit decimals.</p>
153
154 <p><em>static</em> <a href="ion/Decimal/Context">ion\Decimal\Context</a> <a href="ion/Decimal/Context/Dec32">ion\Decimal\Context::Dec32</a>()</p>
155 </li>
156
157 <li>
158 <h3 id="Dec64">
159 <a href="ion/Decimal/Context/Dec64">Dec64</a><a class="permalink" href="ion/Decimal/Context#Dec64">#</a>
160 </h3>
161 <p>Create a context suitable for 64bit decimals.</p>
162
163 <p><em>static</em> <a href="ion/Decimal/Context">ion\Decimal\Context</a> <a href="ion/Decimal/Context/Dec64">ion\Decimal\Context::Dec64</a>()</p>
164 </li>
165
166 <li>
167 <h3 id="DecMax">
168 <a href="ion/Decimal/Context/DecMax">DecMax</a><a class="permalink" href="ion/Decimal/Context#DecMax">#</a>
169 </h3>
170 <p>Create a context with maximum settings.</p>
171
172 <p><em>static</em> <a href="ion/Decimal/Context">ion\Decimal\Context</a> <a href="ion/Decimal/Context/DecMax">ion\Decimal\Context::DecMax</a>([<a href="ion/Decimal/Context/Rounding">ion\Decimal\Context\Rounding</a>|<code><a href="https://php.net/manual/en/language.types.integer">int</a></code> <span class="var">$round</span> = <a href="ion/Decimal/Context/Rounding#HalfEven">ion\Decimal\Context\Rounding::HalfEven</a>])</p>
173 </li>
174
175 <li>
176 <h3 id="Rounding">
177 <a href="ion/Decimal/Context/Rounding">Rounding</a><a class="permalink" href="ion/Decimal/Context#Rounding">#</a>
178 </h3>
179 <p>Rounding mode.</p>
180
181 <p><code><a href="https://php.net/manual/en/language.types.enumerations">enum</a></code> <a href="ion/Decimal/Context/Rounding">ion\Decimal\Context\Rounding</a> <em>implements</em> <code><a href="https://php.net/manual/en/class.backedenum">BackedEnum</a></code></p>
182 </li>
183
184 </ul>
185 <div id="disqus_thread"><button id="disqus_activator">Show <span> </span> Comment(s)</button></div>
186 <script>
187 var disqus_shortname = 'mdref';
188 var disqus_identifier = 'ion/Decimal/Context';
189 </script>
190
191 <footer>
192
193 <ul>
194 <li><a href="https://github.com/m6w6/mdref">mdref-v3.0
195 </a></li>
196 <li><a href="LICENSE">&copy; 2013-2022 All rights reserved.</a></li>
197 <li>
198 </li>
199 </ul>
200
201 </footer>
202
203 <script src="index.js"></script>
204
205 </div>
206 </body>
207 </html>