-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathhashing.html
More file actions
191 lines (191 loc) · 13.7 KB
/
hashing.html
File metadata and controls
191 lines (191 loc) · 13.7 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
<!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.9.2" />
<title>dalpy.hashing API documentation</title>
<meta name="description" content="Module that holds classes related to hashing …" />
<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.hashing</code></h1>
</header>
<section id="section-intro">
<p>Module that holds classes related to hashing.</p>
<p>This module contains the <code><a title="dalpy.hashing.HashTable" href="#dalpy.hashing.HashTable">HashTable</a></code> class. <code><a title="dalpy.hashing.HashTable" href="#dalpy.hashing.HashTable">HashTable</a></code> represents a hash table.</p>
<h2 id="examples">Examples</h2>
<p>Creating a <code><a title="dalpy.hashing.HashTable" href="#dalpy.hashing.HashTable">HashTable</a></code>, adding key-value pairs, and retrieving values:</p>
<pre><code>t = HashTable()
t.insert('a', 1)
t.insert('b', 2)
t.insert('c', 3)
x = t.get_value('a')
</code></pre>
<p>Removing elements from a <code><a title="dalpy.hashing.HashTable" href="#dalpy.hashing.HashTable">HashTable</a></code>:</p>
<pre><code>t.delete('a')
</code></pre>
</section>
<section>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="dalpy.hashing.HashTable"><code class="flex name class">
<span>class <span class="ident">HashTable</span></span>
</code></dt>
<dd>
<div class="desc"><p>Represents a hash table that stores key-value pairs.</p>
<h2 id="examples">Examples</h2>
<p>To initialize a <code><a title="dalpy.hashing.HashTable" href="#dalpy.hashing.HashTable">HashTable</a></code>:</p>
<pre><code>t = HashTable()
</code></pre>
<p>To insert key-value pairs:</p>
<pre><code>t.insert('a', 1)
t.insert('b', 2)
</code></pre>
<p>To check if <code>t</code> contains a key:</p>
<pre><code>if t.contains_key('a'):
# Do something
</code></pre>
<p>To remove a key-value pair:</p>
<pre><code>t.delete('a')
</code></pre>
<p>To retrieve the keys of a <code><a title="dalpy.hashing.HashTable" href="#dalpy.hashing.HashTable">HashTable</a></code>:</p>
<pre><code>keys = t.keys()
</code></pre>
<p>Initializes an empty <code><a title="dalpy.hashing.HashTable" href="#dalpy.hashing.HashTable">HashTable</a></code> in <code>O(1)</code> time.</p></div>
<h3>Methods</h3>
<dl>
<dt id="dalpy.hashing.HashTable.contains_key"><code class="name flex">
<span>def <span class="ident">contains_key</span></span>(<span>self, key)</span>
</code></dt>
<dd>
<div class="desc"><p>Returns whether this <code><a title="dalpy.hashing.HashTable" href="#dalpy.hashing.HashTable">HashTable</a></code> contains a particular key.</p>
<p>One should assume that this runs in <code>O(1)</code> time w/r/t the number of entries in this <code><a title="dalpy.hashing.HashTable" href="#dalpy.hashing.HashTable">HashTable</a></code>.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>key</code></strong></dt>
<dd>The key being searched.</dd>
</dl>
<h2 id="returns">Returns</h2>
<p><code>True</code> if <code>key</code> is in this <code><a title="dalpy.hashing.HashTable" href="#dalpy.hashing.HashTable">HashTable</a></code> and <code>False</code> otherwise.</p></div>
</dd>
<dt id="dalpy.hashing.HashTable.delete"><code class="name flex">
<span>def <span class="ident">delete</span></span>(<span>self, key)</span>
</code></dt>
<dd>
<div class="desc"><p>Removes the key-value pair with a particular key in the <code><a title="dalpy.hashing.HashTable" href="#dalpy.hashing.HashTable">HashTable</a></code>.</p>
<p>One should assume that this runs in <code>O(1)</code> time w/r/t the number of entries in this <code><a title="dalpy.hashing.HashTable" href="#dalpy.hashing.HashTable">HashTable</a></code>.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>key</code></strong></dt>
<dd>The key specifying which key-value pair in the table should be removed. This can be of any type.</dd>
</dl>
<h2 id="returns">Returns</h2>
<p>The value that was previously associated with <code>key</code> if <code>key</code> is in this <code><a title="dalpy.hashing.HashTable" href="#dalpy.hashing.HashTable">HashTable</a></code> (before the key-value
pair was removed).</p>
<h2 id="raises">Raises</h2>
<dl>
<dt><code>KeyError</code></dt>
<dd>If <code>key</code> is not in this <code><a title="dalpy.hashing.HashTable" href="#dalpy.hashing.HashTable">HashTable</a></code>.</dd>
</dl></div>
</dd>
<dt id="dalpy.hashing.HashTable.get_value"><code class="name flex">
<span>def <span class="ident">get_value</span></span>(<span>self, key)</span>
</code></dt>
<dd>
<div class="desc"><p>Gets the value associated with a key in the <code><a title="dalpy.hashing.HashTable" href="#dalpy.hashing.HashTable">HashTable</a></code>.</p>
<p>One should assume that this runs in <code>O(1)</code> time w/r/t the number of entries in this <code><a title="dalpy.hashing.HashTable" href="#dalpy.hashing.HashTable">HashTable</a></code>.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>key</code></strong></dt>
<dd>The key whose value is being retrieved. This can be of any type.</dd>
</dl>
<h2 id="returns">Returns</h2>
<p>The value associated with <code>key</code> if <code>key</code> is in this <code><a title="dalpy.hashing.HashTable" href="#dalpy.hashing.HashTable">HashTable</a></code>.</p>
<h2 id="raises">Raises</h2>
<dl>
<dt><code>KeyError</code></dt>
<dd>If <code>key</code> is not in this <code><a title="dalpy.hashing.HashTable" href="#dalpy.hashing.HashTable">HashTable</a></code>.</dd>
</dl></div>
</dd>
<dt id="dalpy.hashing.HashTable.insert"><code class="name flex">
<span>def <span class="ident">insert</span></span>(<span>self, key, value)</span>
</code></dt>
<dd>
<div class="desc"><p>Inserts a key-value pair into this <code><a title="dalpy.hashing.HashTable" href="#dalpy.hashing.HashTable">HashTable</a></code>.</p>
<p>One should assume that this runs in <code>O(1)</code> time w/r/t the number of entries in this <code><a title="dalpy.hashing.HashTable" href="#dalpy.hashing.HashTable">HashTable</a></code>.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>key</code></strong></dt>
<dd>A key. If its a new key, then a new entry will be added to this <code><a title="dalpy.hashing.HashTable" href="#dalpy.hashing.HashTable">HashTable</a></code> a new pair is added. This
can be of any type.</dd>
<dt><strong><code>value</code></strong></dt>
<dd>A value to be associated with <code>key</code>. If <code>key</code> is already in this <code><a title="dalpy.hashing.HashTable" href="#dalpy.hashing.HashTable">HashTable</a></code>, then it will now have
<code>value</code> associated with it and the number of entries in the <code><a title="dalpy.hashing.HashTable" href="#dalpy.hashing.HashTable">HashTable</a></code> will not change. This can
be of any type including <code>None</code>.</dd>
</dl></div>
</dd>
<dt id="dalpy.hashing.HashTable.keys"><code class="name flex">
<span>def <span class="ident">keys</span></span>(<span>self)</span>
</code></dt>
<dd>
<div class="desc"><p>Returns a <code>Set</code> of keys in the <code><a title="dalpy.hashing.HashTable" href="#dalpy.hashing.HashTable">HashTable</a></code>.</p>
<p>Note that the returned <code>Set</code> will become invalid when new keys are added or removed. One should assume that this
runs in <code>O(n)</code> time where <code>n</code> is the number of entries in this <code><a title="dalpy.hashing.HashTable" href="#dalpy.hashing.HashTable">HashTable</a></code>.</p>
<h2 id="returns">Returns</h2>
<p>A <code>Set</code> of keys in the <code><a title="dalpy.hashing.HashTable" href="#dalpy.hashing.HashTable">HashTable</a></code>.</p></div>
</dd>
</dl>
</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.hashing.HashTable" href="#dalpy.hashing.HashTable">HashTable</a></code></h4>
<ul class="">
<li><code><a title="dalpy.hashing.HashTable.contains_key" href="#dalpy.hashing.HashTable.contains_key">contains_key</a></code></li>
<li><code><a title="dalpy.hashing.HashTable.delete" href="#dalpy.hashing.HashTable.delete">delete</a></code></li>
<li><code><a title="dalpy.hashing.HashTable.get_value" href="#dalpy.hashing.HashTable.get_value">get_value</a></code></li>
<li><code><a title="dalpy.hashing.HashTable.insert" href="#dalpy.hashing.HashTable.insert">insert</a></code></li>
<li><code><a title="dalpy.hashing.HashTable.keys" href="#dalpy.hashing.HashTable.keys">keys</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.2</a>.</p>
</footer>
</body>
</html>