-
Notifications
You must be signed in to change notification settings - Fork 34
Expand file tree
/
Copy pathstd.math.html
More file actions
222 lines (172 loc) · 5.87 KB
/
Copy pathstd.math.html
File metadata and controls
222 lines (172 loc) · 5.87 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>stdlib 41.2.2 Reference</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
<div id="container">
<div id="product">
<div id="product_logo"></div>
<div id="product_name"><big><b></b></big></div>
<div id="product_description"></div>
</div> <!-- id="product" -->
<div id="main">
<!-- Menu -->
<div id="navigation">
<br/>
<h1>stdlib 41.2.2</h1>
<ul>
<li><a href="../index.html">Index</a></li>
</ul>
<h2>Contents</h2>
<ul>
<li><a href="#Functions">Functions</a></li>
</ul>
<h2>Modules</h2>
<ul class="nowrap">
<li><a href="../modules/std.html">std</a></li>
<li><a href="../modules/std.debug.html">std.debug</a></li>
<li><a href="../modules/std.functional.html">std.functional</a></li>
<li><a href="../modules/std.io.html">std.io</a></li>
<li><strong>std.math</strong></li>
<li><a href="../modules/std.operator.html">std.operator</a></li>
<li><a href="../modules/std.package.html">std.package</a></li>
<li><a href="../modules/std.strict.html">std.strict</a></li>
<li><a href="../modules/std.string.html">std.string</a></li>
<li><a href="../modules/std.table.html">std.table</a></li>
</ul>
<h2>Classes</h2>
<ul class="nowrap">
<li><a href="../classes/std.tree.html">std.tree</a></li>
<li><a href="../classes/std.container.html">std.container</a></li>
<li><a href="../classes/std.object.html">std.object</a></li>
<li><a href="../classes/std.list.html">std.list</a></li>
<li><a href="../classes/std.optparse.html">std.optparse</a></li>
<li><a href="../classes/std.set.html">std.set</a></li>
<li><a href="../classes/std.strbuf.html">std.strbuf</a></li>
</ul>
</div>
<div id="content">
<h1>Module <code>std.math</code></h1>
<p>Additions to the core math module.</p>
<p>
<p> The module table returned by <code>std.math</code> also contains all of the entries from
the core math table. An hygienic way to import this module, then, is simply
to override the core <code>math</code> locally:</p>
<pre>
<span class="keyword">local</span> <span class="global">math</span> = <span class="global">require</span> <span class="string">"std.math"</span>
</pre>
</p>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#floor">floor (n[, p=0])</a></td>
<td class="summary">Extend <code>math.floor</code> to take the number of decimal places.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#monkey_patch">monkey_patch ([namespace=_G])</a></td>
<td class="summary">Overwrite core <code>math</code> methods with <code>std</code> enhanced versions.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#round">round (n[, p=0])</a></td>
<td class="summary">Round a number to a given number of decimal places</td>
</tr>
</table>
<br/>
<br/>
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
Methods
<dl class="function">
<dt>
<a name = "floor"></a>
<strong>floor (n[, p=0])</strong>
</dt>
<dd>
Extend <code>math.floor</code> to take the number of decimal places.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">n</span>
<span class="types"><span class="type">number</span></span>
number
</li>
<li><span class="parameter">p</span>
<span class="types"><span class="type">int</span></span>
number of decimal places to truncate to
(<em>default</em> 0)
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">number</span></span>
<code>n</code> truncated to <code>p</code> decimal places
</ol>
<h3>Usage:</h3>
<ul>
<pre class="example">tenths = floor (magnitude, <span class="number">1</span>)</pre>
</ul>
</dd>
<dt>
<a name = "monkey_patch"></a>
<strong>monkey_patch ([namespace=_G])</strong>
</dt>
<dd>
Overwrite core <code>math</code> methods with <code>std</code> enhanced versions.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">namespace</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
where to install global functions
(<em>default</em> _G)
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
the module table
</ol>
<h3>Usage:</h3>
<ul>
<pre class="example"><span class="global">require</span> <span class="string">"std.math"</span>.monkey_patch ()</pre>
</ul>
</dd>
<dt>
<a name = "round"></a>
<strong>round (n[, p=0])</strong>
</dt>
<dd>
Round a number to a given number of decimal places
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">n</span>
<span class="types"><span class="type">number</span></span>
number
</li>
<li><span class="parameter">p</span>
<span class="types"><span class="type">int</span></span>
number of decimal places to round to
(<em>default</em> 0)
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">number</span></span>
<code>n</code> rounded to <code>p</code> decimal places
</ol>
<h3>Usage:</h3>
<ul>
<pre class="example">roughly = round (exactly, <span class="number">2</span>)</pre>
</ul>
</dd>
</dl>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2018-09-16 19:20:25 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>