-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathindex.html
226 lines (222 loc) · 14.7 KB
/
index.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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
<!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 API documentation</title>
<meta name="description" content="DALPy is a Python package for learning data structures and algorithms. It is based off of *Introduction to Algorithms*
by Thomas H. Cormen, Charles E …" />
<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">Package <code>dalpy</code></h1>
</header>
<section id="section-intro">
<p>DALPy is a Python package for learning data structures and algorithms. It is based off of <em>Introduction to Algorithms</em>
by Thomas H. Cormen, Charles E. Leiserson, Ronald L. Rivest, and Clifford Stein. This library was made specifically for
administering and grading assignments related to data structures and algorithms in computer science.</p>
<p>With this library students can receive progress reports on their problem sets in real time as they complete assignments.
Additionally, student submission assessment is done with unit tests, instead of hand-tracing, ensuring that the grades
that students receive accurately reflect their submissions.</p>
<p>The DALPy testing suite offers extremely lightweight and flexible unit testing utilities that can be used on any
kind of assignment, whether to write functions or build classes. Course administration can be easily streamlined by
restricting which library data structures students are allowed to use on any particular assignment.</p>
<p>DALPy began as a project by two Brandeis University undergraduate students to replace hand-written problem sets
written in pseudocode.</p>
<h2 id="provided-data-structures">Provided Data Structures</h2>
<p>The DALPy library offers a set of fundamental data structures and algorithms, with behavior as specified by H.
Cormen et al.'s <em>Introduction to Algorithms</em>. The following structures (separated by module) are supported:</p>
<ul>
<li><a href="https://dalpy-developers.github.io/DALPy/arrays.html">arrays</a><ul>
<li>Array</li>
<li>Array2D</li>
</ul>
</li>
<li><a href="https://dalpy-developers.github.io/DALPy/queues.html">queues</a><ul>
<li>Queue</li>
</ul>
</li>
<li><a href="https://dalpy-developers.github.io/DALPy/stacks.html">stacks</a><ul>
<li>Stack</li>
</ul>
</li>
<li><a href="https://dalpy-developers.github.io/DALPy/sets.html">sets</a><ul>
<li>Set</li>
</ul>
</li>
<li><a href="https://dalpy-developers.github.io/DALPy/linked_lists.html">linked_lists</a><ul>
<li>SinglyLinkedListNode</li>
<li>DoublyLinkedListNode</li>
</ul>
</li>
<li><a href="https://dalpy-developers.github.io/DALPy/trees.html">trees</a><ul>
<li>BinaryTreeNode</li>
<li>NaryTreeNode</li>
<li>depth(NaryTreeNode)</li>
</ul>
</li>
<li><a href="https://dalpy-developers.github.io/DALPy/hashing.html">hashing</a><ul>
<li>HashTable</li>
</ul>
</li>
<li><a href="https://dalpy-developers.github.io/DALPy/heaps.html">heaps</a><ul>
<li>PriorityQueue</li>
<li>build_min_heap(Array)</li>
</ul>
</li>
<li><a href="https://dalpy-developers.github.io/DALPy/graphs.html">graphs</a><ul>
<li>Vertex</li>
<li>Graph</li>
</ul>
</li>
</ul>
<h2 id="unit-testing">Unit Testing</h2>
<p>Along with the DALPy data structures come test utilities for writing test cases. The testing framework allows a
course administrator to easily write test cases for either expected function output or general class behavior. Test
cases can then be compiled into a testing suite. The testing suite has the capability to set a test case run-time
timeout and to record comma-separated test results for administrative use.</p>
<p>Consider the example test case below:</p>
<pre><code>import unittest
from dalpy.factory_utils import make_stack
from dalpy.test_utils import build_and_run_watched_suite, generic_test
from student_submission import student_function
# TestCase class for testing student_function
class StudentFunctionTest(unittest.TestCase):
# A single test case
def simple_test_case(self):
stack = make_stack([1, 2, 3])
expected = make_stack([1, 1, 2, 2, 3, 3])
generic_test(stack, expected, student_function, in_place=True)
# Run the test cases using build_and_run_watched_suite with a timeout of 4 seconds
if __name__ == '__main__':
build_and_run_watched_suite([StudentFunctionTest], 4)
</code></pre>
<h2 id="installation">Installation</h2>
<p>DALPy is <a href="https://pypi.org/project/dalpy/">available on PyPI</a>, and can be installed with pip.</p>
<pre><code>pip install dalpy
</code></pre>
<p>DALPy has the following dependencies:</p>
<pre><code>Python >= 3.6
</code></pre>
<h2 id="issues">Issues</h2>
<p>We encourage you to report issues using the GitHub tracker. We welcome all kinds of issues, especially those related to
correctness, documentation and feature requests.</p>
<h2 id="academic-usage">Academic Usage</h2>
<p>If you are planning to use DALPy for a university course and have questions, feel free to reach out by email.</p>
<h2 id="documentation">Documentation</h2>
<p>The full documentation for DALPy is available <a href="https://dalpy-developers.github.io/DALPy/">here</a>.</p>
<h2 id="sample-usage">Sample Usage</h2>
<p>To view sample assignments using DALPy browse the <a href="https://github.com/DALPy-Developers/DALPy-Sample-Problems">DALPy sample problems repository</a> on GitHub.</p>
<h2 id="notes">Notes</h2>
<p>This project was formerly known as Cormen-Lib.</p>
</section>
<section>
<h2 class="section-title" id="header-submodules">Sub-modules</h2>
<dl>
<dt><code class="name"><a title="dalpy.arrays" href="arrays.html">dalpy.arrays</a></code></dt>
<dd>
<div class="desc"><p>Module that holds classes and functions related to 1 and 2 dimensional arrays …</p></div>
</dd>
<dt><code class="name"><a title="dalpy.factory_utils" href="factory_utils.html">dalpy.factory_utils</a></code></dt>
<dd>
<div class="desc"><p>This module provides factory functions for creating and modifying DALPy objects …</p></div>
</dd>
<dt><code class="name"><a title="dalpy.graphs" href="graphs.html">dalpy.graphs</a></code></dt>
<dd>
<div class="desc"><p>This module holds classes related to graphs …</p></div>
</dd>
<dt><code class="name"><a title="dalpy.hashing" href="hashing.html">dalpy.hashing</a></code></dt>
<dd>
<div class="desc"><p>Module that holds classes related to hashing …</p></div>
</dd>
<dt><code class="name"><a title="dalpy.heaps" href="heaps.html">dalpy.heaps</a></code></dt>
<dd>
<div class="desc"><p>This module holds classes and functions related to heaps and priority queues …</p></div>
</dd>
<dt><code class="name"><a title="dalpy.linked_lists" href="linked_lists.html">dalpy.linked_lists</a></code></dt>
<dd>
<div class="desc"><p>Module that holds classes related to linked lists …</p></div>
</dd>
<dt><code class="name"><a title="dalpy.misc_utils" href="misc_utils.html">dalpy.misc_utils</a></code></dt>
<dd>
<div class="desc"><p>This module provides miscellaneous utility functions and constants …</p></div>
</dd>
<dt><code class="name"><a title="dalpy.queues" href="queues.html">dalpy.queues</a></code></dt>
<dd>
<div class="desc"><p>This module holds classes related to FIFO queues …</p></div>
</dd>
<dt><code class="name"><a title="dalpy.sets" href="sets.html">dalpy.sets</a></code></dt>
<dd>
<div class="desc"><p>Module that holds classes related to sets …</p></div>
</dd>
<dt><code class="name"><a title="dalpy.stacks" href="stacks.html">dalpy.stacks</a></code></dt>
<dd>
<div class="desc"><p>This module holds classes related to LIFO stacks …</p></div>
</dd>
<dt><code class="name"><a title="dalpy.test_utils" href="test_utils.html">dalpy.test_utils</a></code></dt>
<dd>
<div class="desc"><p>This module provides utilities related to unit testing …</p></div>
</dd>
<dt><code class="name"><a title="dalpy.trees" href="trees.html">dalpy.trees</a></code></dt>
<dd>
<div class="desc"><p>Module that holds classes and functions related to trees …</p></div>
</dd>
</dl>
</section>
<section>
</section>
<section>
</section>
<section>
</section>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul>
<li><a href="#provided-data-structures">Provided Data Structures</a></li>
<li><a href="#unit-testing">Unit Testing</a></li>
<li><a href="#installation">Installation</a></li>
<li><a href="#issues">Issues</a></li>
<li><a href="#academic-usage">Academic Usage</a></li>
<li><a href="#documentation">Documentation</a></li>
<li><a href="#sample-usage">Sample Usage</a></li>
<li><a href="#notes">Notes</a></li>
</ul>
</div>
<ul id="index">
<li><h3><a href="#header-submodules">Sub-modules</a></h3>
<ul>
<li><code><a title="dalpy.arrays" href="arrays.html">dalpy.arrays</a></code></li>
<li><code><a title="dalpy.factory_utils" href="factory_utils.html">dalpy.factory_utils</a></code></li>
<li><code><a title="dalpy.graphs" href="graphs.html">dalpy.graphs</a></code></li>
<li><code><a title="dalpy.hashing" href="hashing.html">dalpy.hashing</a></code></li>
<li><code><a title="dalpy.heaps" href="heaps.html">dalpy.heaps</a></code></li>
<li><code><a title="dalpy.linked_lists" href="linked_lists.html">dalpy.linked_lists</a></code></li>
<li><code><a title="dalpy.misc_utils" href="misc_utils.html">dalpy.misc_utils</a></code></li>
<li><code><a title="dalpy.queues" href="queues.html">dalpy.queues</a></code></li>
<li><code><a title="dalpy.sets" href="sets.html">dalpy.sets</a></code></li>
<li><code><a title="dalpy.stacks" href="stacks.html">dalpy.stacks</a></code></li>
<li><code><a title="dalpy.test_utils" href="test_utils.html">dalpy.test_utils</a></code></li>
<li><code><a title="dalpy.trees" href="trees.html">dalpy.trees</a></code></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>