-
Notifications
You must be signed in to change notification settings - Fork 4
/
generate.html
112 lines (112 loc) · 4.38 KB
/
generate.html
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
<!DOCTYPE html>
<html>
<head>
<title>numbers.js documentation</title>
<script type="text/javascript" src="./js/jquery.min.js"></script>
<script type="text/javascript" src="./js/bootstrap.min.js"></script>
<link type="text/css" rel="stylesheet" href="./css/bootstrap.min.css">
<link type="text/css" rel="stylesheet" href="./css/doc.css">
</head>
<body>
<nav role="navigation" class="navbar navbar-inverse navbar-fixed-top">
<div class="container-fluid">
<!-- Brand and toggle get grouped for better mobile display -->
<div class="navbar-header">
<button type="button" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1" class="navbar-toggle collapsed"><span class="sr-only">Toggle navigation</span></button><a href="#" class="navbar-brand">numbers.js</a>
</div>
<!-- Collect the nav links, forms, and other content for toggling -->
<div id="bs-example-navbar-collapse-1" class="collapse navbar-collapse">
<ul class="nav navbar-nav">
<li><a href="./index.html">Home <span class="glyphicon glyphicon-home"></span></a></li>
<li><a href="./examples.html">Examples</a></li>
<li class="active dropdown"><a href="#" data-toggle="dropdown" class="dropdown-toggle">Documentation<span class="caret"></span></a>
<ul role="menu" class="dropdown-menu">
<li><a href="./basic.html">basic</a></li>
<li><a href="./calculus.html">calculus</a></li>
<li><a href="./complex.html">complex</a></li>
<li><a href="./dsp.html">dsp</a></li>
<li><a href="./generate.html">generate</a></li>
<li><a href="./matrix.html">matrix</a></li>
<li><a href="./prime.html">prime</a></li>
<li><a href="./random.html">random</a></li>
<li><a href="./statistic.html">statistic</a></li>
</ul>
</li>
</ul>
<ul class="nav navbar-nav navbar-right">
<li><a href="https://github.com/sjkaliski/numbers.js">numbers.js on GitHub</a></li>
<li><a href="https://github.com/stdako/numbersdoc">documentation on GitHub</a></li>
</ul>
</div>
<!--.navbar-collapse -->
</div>
<!--.container-fluid -->
</nav><span id="sidebar">
<ul>
<li><a href="#collatz">generate.collatz</a></li>
<li><a href="#fibonacci">generate.fibonacci</a></li>
</ul></span><span id="api-cont">
<h3><strong>numbers.generate</strong></h3>
<div id="collatz" class="api-func">
<h4>numbers.generate.<b>collatz</b>(n, arr)</h4>
<p>Populates a given array, <i>arr</i>, with a Collatz sequence, starting the sequence at the positive integer <i>n</i>.</p>
<table>
<tr>
<th>Parameters</th>
<td>
<p><b>n</b> : <i>Int</i><br/>
<div class="desc">Starting point.</div>
</p>
<p><b>arr</b> : <i>Array</i><br/>
<div class="desc">An array.</div>
</p>
</td>
</tr>
<tr>
<th>Returns</th>
<td>
<p><b>colArr</b> : <i>Array</i>
<div class="desc"><i>arr</i> populated with the Collatz sequence.</div>
</p>
</td>
</tr>
<tr>
<th>Errors</th>
<td>
<p>This function does not raise any errors.</p>
</td>
</tr>
</table>
<hr/>
</div>
<div id="fibonacci" class="api-func">
<h4>numbers.generate.<b>fibonacci</b>(n)</h4>
<p>Calculates the <i>n</i>th Fibonacci number.</p>
<table>
<tr>
<th>Parameters</th>
<td>
<p><b>n</b> : <i>Int</i><br/>
<div class="desc">Desired Fibonacci number to calculate.</div>
</p>
</td>
</tr>
<tr>
<th>Returns</th>
<td>
<p><b>num</b> : <i>Int</i>
<div class="desc"><i>n</i>th Fibonacci number.</div>
</p>
</td>
</tr>
<tr>
<th>Errors</th>
<td>
<p>This function does not raise any errors.</p>
</td>
</tr>
</table>
<hr/>
</div></span>
</body>
</html>