275 lines
4.4 KiB
HTML
275 lines
4.4 KiB
HTML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
<html>
|
|
<head>
|
|
<title>Luadocs for utils//mathutil.lua</title>
|
|
<link rel="stylesheet" href="../../../luadoc.css" type="text/css" />
|
|
<!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/-->
|
|
</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">
|
|
|
|
<div id="navigation">
|
|
|
|
|
|
<h1>LuaDoc</h1>
|
|
<ul>
|
|
|
|
<li><a href="../../../index.html">Index</a></li>
|
|
|
|
</ul>
|
|
|
|
|
|
<!-- Module list -->
|
|
|
|
|
|
|
|
<!-- File list -->
|
|
|
|
<h1>Files</h1>
|
|
<ul>
|
|
|
|
<li>
|
|
<a href="../../../files/utils//blockedcache.html">utils//blockedcache.lua</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="../../../files/utils//blockutil.html">utils//blockutil.lua</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="../../../files/utils//constants.html">utils//constants.lua</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="../../../files/utils//init.html">utils//init.lua</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="../../../files/utils//interpolate.html">utils//interpolate.lua</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="../../../files/utils//list.html">utils//list.lua</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="../../../files/utils//log.html">utils//log.lua</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="../../../files/utils//mapmanipulator.html">utils//mapmanipulator.lua</a>
|
|
</li>
|
|
|
|
<li><strong>utils//mathutil.lua</strong></li>
|
|
|
|
<li>
|
|
<a href="../../../files/utils//noisemanager.html">utils//noisemanager.lua</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="../../../files/utils//scatterer.html">utils//scatterer.lua</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="../../../files/utils//stopwatch.html">utils//stopwatch.lua</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="../../../files/utils//stringutil.html">utils//stringutil.lua</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="../../../files/utils//tableutil.html">utils//tableutil.lua</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="../../../files/utils//test.html">utils//test.lua</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="../../../files/utils//transform.html">utils//transform.lua</a>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div> <!-- id="navigation" -->
|
|
|
|
<div id="content">
|
|
|
|
<h1>File <code>utils//mathutil.lua</code></h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2>Functions</h2>
|
|
<table class="function_list">
|
|
|
|
<tr>
|
|
<td class="name" nowrap><a href="#mathutil.clamp">mathutil.clamp</a> (value, min, max)</td>
|
|
<td class="summary">Clamps one value to the given minimum/maximum values.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="name" nowrap><a href="#mathutil.next_lower_prime">mathutil.next_lower_prime</a> (number)</td>
|
|
<td class="summary">Gets the next lower prime from the given number.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="name" nowrap><a href="#mathutil.round">mathutil.round</a> (value, decimal_places)</td>
|
|
<td class="summary">Rounds to the nearest number with the given decimal places.</td>
|
|
</tr>
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<br/>
|
|
<br/>
|
|
|
|
|
|
|
|
|
|
<h2><a name="functions"></a>Functions</h2>
|
|
<dl class="function">
|
|
|
|
|
|
|
|
<dt><a name="mathutil.clamp"></a><strong>mathutil.clamp</strong> (value, min, max)</dt>
|
|
<dd>
|
|
Clamps one value to the given minimum/maximum values. Defaults to 0 to 1 if min/max are omitted.
|
|
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
|
|
<li>
|
|
value: The value to clamp.
|
|
</li>
|
|
|
|
<li>
|
|
min: Optional. The minimum value, defaults to 0.
|
|
</li>
|
|
|
|
<li>
|
|
max: Optional. The masximum value, defaults to 1.
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Return value:</h3>
|
|
The value clamped to the given range.
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
|
|
|
|
|
<dt><a name="mathutil.next_lower_prime"></a><strong>mathutil.next_lower_prime</strong> (number)</dt>
|
|
<dd>
|
|
Gets the next lower prime from the given number.
|
|
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
|
|
<li>
|
|
number: The number.
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Return value:</h3>
|
|
The next lower prime.
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
|
|
|
|
|
<dt><a name="mathutil.round"></a><strong>mathutil.round</strong> (value, decimal_places)</dt>
|
|
<dd>
|
|
Rounds to the nearest number with the given decimal places.
|
|
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
|
|
<li>
|
|
value: The value to round.
|
|
</li>
|
|
|
|
<li>
|
|
decimal_places: Optional. The number of decimal places to round to, defaults to 0.
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Return value:</h3>
|
|
The rounded value.
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div> <!-- id="content" -->
|
|
|
|
</div> <!-- id="main" -->
|
|
|
|
<div id="about">
|
|
<p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>
|
|
</div> <!-- id="about" -->
|
|
|
|
</div> <!-- id="container" -->
|
|
</body>
|
|
</html>
|