af4bc9cbf0f43502f06d4d2fb5801806f246468a
[awesomized/ext-ion] / docs / v0.2 / 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 property="og:title" content="ion\Decimal\Context">
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/Context">
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 &uarr; <a href="./ion/Decimal">
40 Decimal
41 </a>
42 <ul>
43 <li>
44
45 &circlearrowright; <strong><a href="./ion/Decimal/Context">Context</a></strong>
46
47
48 <ul>
49
50 <li>
51 &rdsh; <a href="./ion/Decimal/Context/Dec128">Dec128</a>
52
53 </li>
54
55 <li>
56 &rdsh; <a href="./ion/Decimal/Context/Dec32">Dec32</a>
57
58 </li>
59
60 <li>
61 &rdsh; <a href="./ion/Decimal/Context/Dec64">Dec64</a>
62
63 </li>
64
65 <li>
66 &rdsh; <a href="./ion/Decimal/Context/DecMax">DecMax</a>
67
68 </li>
69
70 <li>
71 &rdsh; <a href="./ion/Decimal/Context/Rounding">Rounding</a>
72
73 </li>
74
75 <li>
76 &rdsh; <a href="./ion/Decimal/Context/__construct">Context::__construct</a>
77
78 </li>
79
80 </ul>
81
82
83 </ul>
84
85 <li>&ldsh; <a href="./ion/Decimal/__construct">Decimal::__construct</a></li>
86
87 <li>&ldsh; <a href="./ion/Decimal/equals">Decimal::equals</a></li>
88
89 <li>&ldsh; <a href="./ion/Decimal/isInt">Decimal::isInt</a></li>
90
91 <li>&ldsh; <a href="./ion/Decimal/toInt">Decimal::toInt</a></li>
92
93 <li>&ldsh; <a href="./ion/Decimal/toString">Decimal::toString</a></li>
94
95 </ul>
96
97 </li>
98 </ul>
99
100 </li>
101 </ul>
102 </div>
103 <meta charset="utf-8"><h1>
104 <a class="permalink" href="ion/Decimal/Context#">#</a><em>class</em> <a href="ion/Decimal/Context">ion\Decimal\Context</a>
105 </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>
106 </h2><p>None.</p><h2 id="Properties:">Properties:<a class="permalink" href="ion/Decimal/Context#Properties:">#</a>
107 </h2><ul>
108 <li>
109 <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>
110 Maximum digits.</li>
111 <li>
112 <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>
113 Maximum exponent.</li>
114 <li>
115 <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>
116 Minimum exponent.</li>
117 <li>
118 <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>
119 Rounding mode.</li>
120 <li>
121 <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>
122 Whether to clamp.</li>
123 </ul><h2 id="Functions:">Functions:<a class="permalink" href="ion/Decimal/Context#Functions:">#</a>
124 </h2><ul class="sub-entries sub-functions">
125
126 <li>
127 <h3 id="Context::__construct">
128 <a href="ion/Decimal/Context/__construct">Context::__construct</a><a class="permalink" href="ion/Decimal/Context#Context::__construct">#</a>
129 </h3>
130 <p>Create a new decimal context.</p>
131
132 <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>
133 </li>
134
135 </ul><h2 id="Namespaces.Interfaces.and.Classes:">Namespaces, Interfaces and Classes:<a class="permalink" href="ion/Decimal/Context#Namespaces.Interfaces.and.Classes:">#</a>
136 </h2><ul class="sub-entries sub-ns-classes">
137
138 <li>
139 <h3 id="Dec128">
140 <a href="ion/Decimal/Context/Dec128">Dec128</a><a class="permalink" href="ion/Decimal/Context#Dec128">#</a>
141 </h3>
142 <p>Create a context suitable for 128bit decimals.</p>
143
144 <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>
145 </li>
146
147 <li>
148 <h3 id="Dec32">
149 <a href="ion/Decimal/Context/Dec32">Dec32</a><a class="permalink" href="ion/Decimal/Context#Dec32">#</a>
150 </h3>
151 <p>Create a context suitable for 32bit decimals.</p>
152
153 <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>
154 </li>
155
156 <li>
157 <h3 id="Dec64">
158 <a href="ion/Decimal/Context/Dec64">Dec64</a><a class="permalink" href="ion/Decimal/Context#Dec64">#</a>
159 </h3>
160 <p>Create a context suitable for 64bit decimals.</p>
161
162 <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>
163 </li>
164
165 <li>
166 <h3 id="DecMax">
167 <a href="ion/Decimal/Context/DecMax">DecMax</a><a class="permalink" href="ion/Decimal/Context#DecMax">#</a>
168 </h3>
169 <p>Create a context with maximum settings.</p>
170
171 <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>
172 </li>
173
174 <li>
175 <h3 id="Rounding">
176 <a href="ion/Decimal/Context/Rounding">Rounding</a><a class="permalink" href="ion/Decimal/Context#Rounding">#</a>
177 </h3>
178 <p>Rounding mode.</p>
179
180 <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>
181 </li>
182
183 </ul>
184 <div class="comments">
185 <style>.giscus-frame {min-height: 16em;}</style>
186 <script>
187 function giscus_load(button) {
188 let script = document.createElement("script");
189 script.setAttribute("data-repo", 'awesomized/ext-ion');
190 script.setAttribute("data-category", 'Comments on Docs');
191 script.setAttribute("data-repo-id", 'R_kgDOGfXEXw');
192 script.setAttribute("data-category-id", 'DIC_kwDOGfXEX84CBHuf');
193 script.setAttribute("data-mapping", 'og:title');
194 script.setAttribute("data-input-position", 'bottom');
195 script.setAttribute("data-reactions-enabled", false);
196 script.setAttribute("data-theme", 'light');
197 script.setAttribute("data-lang", 'en');
198
199 script.src = "//giscus.app/client.js";
200 button.parentNode.replaceChild(script, button);
201 }
202 </script>
203 <button class="activator" onclick="giscus_load(this)">Show Comments from Github Discussions</button>
204
205 </div>
206
207 <footer>
208
209 <ul>
210 <li><a href="https://github.com/m6w6/mdref">mdref-v3.0
211 </a></li>
212 <li><a href="LICENSE">&copy; 2013-2022 All rights reserved.</a></li>
213 <li>
214 </li>
215 </ul>
216
217 </footer>
218
219 <script src="index.js" defer></script>
220
221 </div>
222 </body>
223 </html>