emath
Version:
This is a module for math.
877 lines (212 loc) • 8.67 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>Global</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Global</h1>
<section>
<header>
<h2></h2>
</header>
<article>
<div class="container-overview">
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="max"><span class="type-signature"></span>max<span class="signature">(numbers)</span><span class="type-signature"></span></h4>
<div class="description">
To get the max number of numbers
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>numbers</code></td>
<td class="type">
<span class="param-type">array</span>
</td>
<td class="description last">A array</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="compare.js.html">compare.js</a>, <a href="compare.js.html#line15">line 15</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The max number of numbers
</div>
<h4 class="name" id="min"><span class="type-signature"></span>min<span class="signature">(numbers)</span><span class="type-signature"></span></h4>
<div class="description">
To get the min number of numbers
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>numbers</code></td>
<td class="type">
<span class="param-type">array</span>
</td>
<td class="description last">A array</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="compare.js.html">compare.js</a>, <a href="compare.js.html#line45">line 45</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The min number of numbers
</div>
<h4 class="name" id="sort"><span class="type-signature"></span>sort<span class="signature">(numbers, cmp)</span><span class="type-signature"></span></h4>
<div class="description">
To sort the numbers (cmp)
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>numbers</code></td>
<td class="type">
<span class="param-type">array</span>
</td>
<td class="description last">A array</td>
</tr>
<tr>
<td class="name"><code>cmp</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">A function</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="compare.js.html">compare.js</a>, <a href="compare.js.html#line73">line 73</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The sorted number of numbers (cmp)
</div>
<h4 class="name" id="sort_max"><span class="type-signature"></span>sort_max<span class="signature">(numbers)</span><span class="type-signature"></span></h4>
<div class="description">
To sort the numbers (From max to min)
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>numbers</code></td>
<td class="type">
<span class="param-type">array</span>
</td>
<td class="description last">A array</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="compare.js.html">compare.js</a>, <a href="compare.js.html#line119">line 119</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The sorted number of numbers (From max to min)
</div>
<h4 class="name" id="sort_min"><span class="type-signature"></span>sort_min<span class="signature">(numbers)</span><span class="type-signature"></span></h4>
<div class="description">
To sort the numbers (From max to min)
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>numbers</code></td>
<td class="type">
<span class="param-type">array</span>
</td>
<td class="description last">A array</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="compare.js.html">compare.js</a>, <a href="compare.js.html#line92">line 92</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The sorted number of numbers (From max to min)
</div>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.html#max">max</a></li><li><a href="global.html#min">min</a></li><li><a href="global.html#sort">sort</a></li><li><a href="global.html#sort_max">sort_max</a></li><li><a href="global.html#sort_min">sort_min</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Aug 13 2018 15:55:36 GMT+0800 (CST)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>