-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathstacks.html
182 lines (182 loc) · 13.3 KB
/
stacks.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
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
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.10.0" />
<title>dalpy.stacks API documentation</title>
<meta name="description" content="This module holds classes related to LIFO stacks …" />
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>dalpy.stacks</code></h1>
</header>
<section id="section-intro">
<p>This module holds classes related to LIFO stacks.</p>
<p>This module contains <code><a title="dalpy.stacks.Stack" href="#dalpy.stacks.Stack">Stack</a></code>, an implementation of a LIFO stack, and <code><a title="dalpy.stacks.StackUnderflowError" href="#dalpy.stacks.StackUnderflowError">StackUnderflowError</a></code>, an error raised by <code><a title="dalpy.stacks.Stack" href="#dalpy.stacks.Stack">Stack</a></code>.</p>
<h2 id="examples">Examples</h2>
<p>Initializing, adding, and removing elements from a <code><a title="dalpy.stacks.Stack" href="#dalpy.stacks.Stack">Stack</a></code>:</p>
<pre><code>s = Stack()
s.push(1)
s.push(2)
s.pop()
</code></pre>
<p>The following code will raise a <code><a title="dalpy.stacks.StackUnderflowError" href="#dalpy.stacks.StackUnderflowError">StackUnderflowError</a></code> because the second pop is done on an empty <code><a title="dalpy.stacks.Stack" href="#dalpy.stacks.Stack">Stack</a></code>:</p>
<pre><code>s.pop()
s.pop()
</code></pre>
</section>
<section>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="dalpy.stacks.Stack"><code class="flex name class">
<span>class <span class="ident">Stack</span></span>
</code></dt>
<dd>
<div class="desc"><p>This class represents a LIFO stack that has no maximum capacity.</p>
<h2 id="examples">Examples</h2>
<p>To initialize a <code><a title="dalpy.stacks.Stack" href="#dalpy.stacks.Stack">Stack</a></code>:</p>
<pre><code>s = Stack()
</code></pre>
<p>To add elements to the end of <code>s</code>:</p>
<pre><code>s.push(1)
s.push(2)
</code></pre>
<p>To remove and return the element at the top of <code>s</code> (in this case <code>x = 2</code>):</p>
<pre><code>x = s.pop()
</code></pre>
<p>To see the element at the top of <code>s</code> (in this case <code>y = 1</code>):</p>
<pre><code>y = s.top()
</code></pre>
<p>Initializes an empty <code><a title="dalpy.stacks.Stack" href="#dalpy.stacks.Stack">Stack</a></code> in <code>O(1)</code> time.</p></div>
<h3>Methods</h3>
<dl>
<dt id="dalpy.stacks.Stack.is_empty"><code class="name flex">
<span>def <span class="ident">is_empty</span></span>(<span>self)</span>
</code></dt>
<dd>
<div class="desc"><p>Returns <code>True</code> if this <code><a title="dalpy.stacks.Stack" href="#dalpy.stacks.Stack">Stack</a></code> is empty, <code>False</code> otherwise in <code>O(1)</code> time w/r/t the size of this <code><a title="dalpy.stacks.Stack" href="#dalpy.stacks.Stack">Stack</a></code>.</p></div>
</dd>
<dt id="dalpy.stacks.Stack.pop"><code class="name flex">
<span>def <span class="ident">pop</span></span>(<span>self)</span>
</code></dt>
<dd>
<div class="desc"><p>Removes the element at the top of this <code><a title="dalpy.stacks.Stack" href="#dalpy.stacks.Stack">Stack</a></code>.</p>
<p>This operation runs in <code>O(1)</code> time with respect to the size of this <code><a title="dalpy.stacks.Stack" href="#dalpy.stacks.Stack">Stack</a></code>.</p>
<h2 id="returns">Returns</h2>
<p>The element at the top of the <code><a title="dalpy.stacks.Stack" href="#dalpy.stacks.Stack">Stack</a></code> that was removed. That is, the element that was last added to this
<code><a title="dalpy.stacks.Stack" href="#dalpy.stacks.Stack">Stack</a></code> of the elements in it.</p>
<h2 id="raises">Raises</h2>
<dl>
<dt><code><a title="dalpy.stacks.StackUnderflowError" href="#dalpy.stacks.StackUnderflowError">StackUnderflowError</a></code></dt>
<dd>If this <code><a title="dalpy.stacks.Stack" href="#dalpy.stacks.Stack">Stack</a></code> is empty.</dd>
</dl></div>
</dd>
<dt id="dalpy.stacks.Stack.push"><code class="name flex">
<span>def <span class="ident">push</span></span>(<span>self, value)</span>
</code></dt>
<dd>
<div class="desc"><p>Adds an element to the top of this <code><a title="dalpy.stacks.Stack" href="#dalpy.stacks.Stack">Stack</a></code>.</p>
<p>This operation runs in <code>O(1)</code> time with respect to the size of this <code><a title="dalpy.stacks.Stack" href="#dalpy.stacks.Stack">Stack</a></code>.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>value</code></strong></dt>
<dd>Element to add to this <code><a title="dalpy.stacks.Stack" href="#dalpy.stacks.Stack">Stack</a></code>. It can be of any type.</dd>
</dl></div>
</dd>
<dt id="dalpy.stacks.Stack.size"><code class="name flex">
<span>def <span class="ident">size</span></span>(<span>self)</span>
</code></dt>
<dd>
<div class="desc"><p>Returns the integer number of elements in this <code><a title="dalpy.stacks.Stack" href="#dalpy.stacks.Stack">Stack</a></code> in <code>O(1)</code> time w/r/t the size of this <code><a title="dalpy.stacks.Stack" href="#dalpy.stacks.Stack">Stack</a></code>.</p></div>
</dd>
<dt id="dalpy.stacks.Stack.top"><code class="name flex">
<span>def <span class="ident">top</span></span>(<span>self)</span>
</code></dt>
<dd>
<div class="desc"><p>Gets the element at the top of this <code><a title="dalpy.stacks.Stack" href="#dalpy.stacks.Stack">Stack</a></code>.</p>
<p>This operation runs in <code>O(1)</code> time with respect to the size of this <code><a title="dalpy.stacks.Stack" href="#dalpy.stacks.Stack">Stack</a></code>.</p>
<h2 id="returns">Returns</h2>
<p>The element at the top of the <code><a title="dalpy.stacks.Stack" href="#dalpy.stacks.Stack">Stack</a></code>. That is, the element that was last added to this <code><a title="dalpy.stacks.Stack" href="#dalpy.stacks.Stack">Stack</a></code> of the
elements in it.</p>
<h2 id="raises">Raises</h2>
<dl>
<dt><code><a title="dalpy.stacks.StackUnderflowError" href="#dalpy.stacks.StackUnderflowError">StackUnderflowError</a></code></dt>
<dd>If this <code><a title="dalpy.stacks.Stack" href="#dalpy.stacks.Stack">Stack</a></code> is empty.</dd>
</dl></div>
</dd>
</dl>
</dd>
<dt id="dalpy.stacks.StackUnderflowError"><code class="flex name class">
<span>class <span class="ident">StackUnderflowError</span></span>
<span>(</span><span>operation)</span>
</code></dt>
<dd>
<div class="desc"><p>This class is used by <code><a title="dalpy.stacks.Stack" href="#dalpy.stacks.Stack">Stack</a></code> to raise errors for operations done on an empty <code><a title="dalpy.stacks.Stack" href="#dalpy.stacks.Stack">Stack</a></code>.</p>
<p>Initializes a <code><a title="dalpy.stacks.StackUnderflowError" href="#dalpy.stacks.StackUnderflowError">StackUnderflowError</a></code> that will be raised associated with a particular <code><a title="dalpy.stacks.Stack" href="#dalpy.stacks.Stack">Stack</a></code> operation.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>operation</code></strong></dt>
<dd>a string specifying the operation to raise an error on</dd>
</dl></div>
<h3>Ancestors</h3>
<ul class="hlist">
<li>builtins.Exception</li>
<li>builtins.BaseException</li>
</ul>
</dd>
</dl>
</section>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="dalpy" href="index.html">dalpy</a></code></li>
</ul>
</li>
<li><h3><a href="#header-classes">Classes</a></h3>
<ul>
<li>
<h4><code><a title="dalpy.stacks.Stack" href="#dalpy.stacks.Stack">Stack</a></code></h4>
<ul class="">
<li><code><a title="dalpy.stacks.Stack.is_empty" href="#dalpy.stacks.Stack.is_empty">is_empty</a></code></li>
<li><code><a title="dalpy.stacks.Stack.pop" href="#dalpy.stacks.Stack.pop">pop</a></code></li>
<li><code><a title="dalpy.stacks.Stack.push" href="#dalpy.stacks.Stack.push">push</a></code></li>
<li><code><a title="dalpy.stacks.Stack.size" href="#dalpy.stacks.Stack.size">size</a></code></li>
<li><code><a title="dalpy.stacks.Stack.top" href="#dalpy.stacks.Stack.top">top</a></code></li>
</ul>
</li>
<li>
<h4><code><a title="dalpy.stacks.StackUnderflowError" href="#dalpy.stacks.StackUnderflowError">StackUnderflowError</a></code></h4>
</li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
</footer>
</body>
</html>