Uh oh!
There was an error while loading. Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathexample_code.html
More file actions
Latest commit
523 lines (465 loc) · 55.2 KB
/
Copy pathexample_code.html
File metadata and controls
523 lines (465 loc) · 55.2 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
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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
<!DOCTYPE html>
<htmllang="en" data-content_root="./">
<head>
<metacharset="utf-8" />
<metaname="viewport" content="width=device-width, initial-scale=1.0" /><metaname="viewport" content="width=device-width, initial-scale=1" />
<title>example_code package — Object-oriented Programming documentation</title>
<linkrel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
<linkrel="stylesheet" type="text/css" href="_static/fenics.css?v=8c7d05f9" />
<linkrel="stylesheet" type="text/css" href="_static/proof.css" />
<linkrel="stylesheet" type="text/css" href="_static/graphviz.css?v=fd3f3429" />
<scriptsrc="_static/documentation_options.js?v=5929fcd5"></script>
<scriptsrc="_static/doctools.js?v=9a2dae69"></script>
<scriptsrc="_static/sphinx_highlight.js?v=dc90522c"></script>
<scriptsrc="_static/proof.js"></script>
<linkrel="index" title="Index" href="genindex.html" />
<linkrel="search" title="Search" href="search.html" />
<!--[if lte IE 6]>
<link rel="stylesheet" href="_static/ie6.css" type="text/css" media="screen" charset="utf-8" />
<![endif]-->
<!-- Global site tag (gtag.js) - Google Analytics -->
<scriptasyncsrc="https://www.googletagmanager.com/gtag/js?id=G-0EFVH5C4DC"></script>
<script>
window.dataLayer=window.dataLayer||[];
functiongtag(){dataLayer.push(arguments);}
gtag('js',newDate());
gtag('config','G-0EFVH5C4DC');
</script>
<linkrel="stylesheet" href="_static/featured.css">
<linkrel="shortcut icon" href="_static/icon.ico" />
</head><body>
<divclass="wrapper">
<ahref="index.html"><imgsrc="_static/banner.png" width="900px" alt="FInAT Project Banner" /></a>
<divid="access">
<divclass="menu">
<ul>
<liclass="page_item"><ahref="index.html" title="Book">Book</a></li>
<liclass="page_item"><ahref="videos.html" title="Videos">Videos</a></li>
<liclass="page_item"><ahref="exercises.html"
title="Exercises">Exercises</a></li>
<liclass="page_item"><ahref="installation.html" title="Installation">Installation</a></li>
</ul>
</div><!-- .menu -->
</div><!-- #access -->
</div><!-- #wrapper -->
<divclass="document">
<divclass="documentwrapper">
<divclass="bodywrapper">
<divclass="body" role="main">
<sectionid="example-code-package">
<h1>example_code package<aclass="headerlink" href="#example-code-package" title="Link to this heading">¶</a></h1>
<sectionid="submodules">
<h2>Submodules<aclass="headerlink" href="#submodules" title="Link to this heading">¶</a></h2>
</section>
<sectionid="module-example_code.addable">
<spanid="example-code-addable-module"></span><h2>example_code.addable module<aclass="headerlink" href="#module-example_code.addable" title="Link to this heading">¶</a></h2>
<dlclass="py class">
<dtclass="sig sig-object py" id="example_code.addable.Addable">
<emclass="property"><spanclass="pre">class</span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">example_code.addable.</span></span><spanclass="sig-name descname"><spanclass="pre">Addable</span></span><aclass="reference internal" href="_modules/example_code/addable.html#Addable"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#example_code.addable.Addable" title="Link to this definition">¶</a></dt>
<dd><p>Bases: <aclass="reference external" href="https://docs.python.org/3/library/abc.html#abc.ABC" title="(in Python v3.14)"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ABC</span></code></a></p>
</dd></dl>
</section>
<sectionid="module-example_code.euclid">
<spanid="example-code-euclid-module"></span><h2>example_code.euclid module<aclass="headerlink" href="#module-example_code.euclid" title="Link to this heading">¶</a></h2>
<dlclass="py function">
<dtclass="sig sig-object py" id="example_code.euclid.gcd">
<spanclass="sig-prename descclassname"><spanclass="pre">example_code.euclid.</span></span><spanclass="sig-name descname"><spanclass="pre">gcd</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">a</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">b</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/example_code/euclid.html#gcd"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#example_code.euclid.gcd" title="Link to this definition">¶</a></dt>
<dd><p>Return the greatest common divisor of a and b using a recursive
implementation of Euclid’s algorithm.</p>
</dd></dl>
</section>
<sectionid="module-example_code.expression_tools">
<spanid="example-code-expression-tools-module"></span><h2>example_code.expression_tools module<aclass="headerlink" href="#module-example_code.expression_tools" title="Link to this heading">¶</a></h2>
<dlclass="py function">
<dtclass="sig sig-object py" id="example_code.expression_tools.evaluate">
<spanclass="sig-prename descclassname"><spanclass="pre">example_code.expression_tools.</span></span><spanclass="sig-name descname"><spanclass="pre">evaluate</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">expr</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">*</span></span><spanclass="n"><spanclass="pre">o</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/example_code/expression_tools.html#evaluate"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#example_code.expression_tools.evaluate" title="Link to this definition">¶</a></dt>
<dtclass="sig sig-object py">
<spanclass="sig-prename descclassname"><spanclass="pre">example_code.expression_tools.</span></span><spanclass="sig-name descname"><spanclass="pre">evaluate</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">expr</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">Number</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">*</span></span><spanclass="n"><spanclass="pre">o</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span></dt>
<dtclass="sig sig-object py">
<spanclass="sig-prename descclassname"><spanclass="pre">example_code.expression_tools.</span></span><spanclass="sig-name descname"><spanclass="pre">evaluate</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">expr</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">Symbol</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">*</span></span><spanclass="n"><spanclass="pre">o</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">symbol_map</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span></dt>
<dtclass="sig sig-object py">
<spanclass="sig-prename descclassname"><spanclass="pre">example_code.expression_tools.</span></span><spanclass="sig-name descname"><spanclass="pre">evaluate</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">expr</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">Add</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">*</span></span><spanclass="n"><spanclass="pre">o</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span></dt>
<dtclass="sig sig-object py">
<spanclass="sig-prename descclassname"><spanclass="pre">example_code.expression_tools.</span></span><spanclass="sig-name descname"><spanclass="pre">evaluate</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">expr</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">Sub</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">*</span></span><spanclass="n"><spanclass="pre">o</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span></dt>
<dtclass="sig sig-object py">
<spanclass="sig-prename descclassname"><spanclass="pre">example_code.expression_tools.</span></span><spanclass="sig-name descname"><spanclass="pre">evaluate</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">expr</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">Mul</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">*</span></span><spanclass="n"><spanclass="pre">o</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span></dt>
<dtclass="sig sig-object py">
<spanclass="sig-prename descclassname"><spanclass="pre">example_code.expression_tools.</span></span><spanclass="sig-name descname"><spanclass="pre">evaluate</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">expr</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">Div</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">*</span></span><spanclass="n"><spanclass="pre">o</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span></dt>
<dtclass="sig sig-object py">
<spanclass="sig-prename descclassname"><spanclass="pre">example_code.expression_tools.</span></span><spanclass="sig-name descname"><spanclass="pre">evaluate</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">expr</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">Pow</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">*</span></span><spanclass="n"><spanclass="pre">o</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span></dt>
<dd><p>Evaluate an expression node.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters<spanclass="colon">:</span></dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>expr</strong> (<em>Expression</em>) – The expression node to be evaluated.</p></li>
<li><p><strong>*o</strong> (<aclass="reference external" href="https://docs.python.org/3/library/numbers.html#numbers.Number" title="(in Python v3.14)"><em>numbers.Number</em></a>) – The results of evaluating the operands of expr.</p></li>
<li><p><strong>**kwargs</strong> – Any keyword arguments required to evaluate specific types of
expression.</p></li>
<li><p><strong>symbol_map</strong> (<aclass="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><em>dict</em></a>) – <p>A dictionary mapping Symbol names to numerical values, for
example:</p>
<p>{‘x’: 1}</p>
</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dlclass="py function">
<dtclass="sig sig-object py" id="example_code.expression_tools.postvisitor">
<spanclass="sig-prename descclassname"><spanclass="pre">example_code.expression_tools.</span></span><spanclass="sig-name descname"><spanclass="pre">postvisitor</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">expr</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">fn</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/example_code/expression_tools.html#postvisitor"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#example_code.expression_tools.postvisitor" title="Link to this definition">¶</a></dt>
<dd><p>Visit an Expression in postorder applying a function to every node.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters<spanclass="colon">:</span></dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>expr</strong> (<em>Expression</em>) – The expression to be visited.</p></li>
<li><p><strong>fn</strong> (<codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">function(node,</span><spanclass="pre">*o,</span><spanclass="pre">**kwargs)</span></code>) – A function to be applied at each node. The function should take
the node to be visited as its first argument, and the results of
visiting its operands as any further positional arguments. Any
additional information that the visitor requires can be passed in
as keyword arguments.</p></li>
<li><p><strong>**kwargs</strong> – Any additional keyword arguments to be passed to fn.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</section>
<sectionid="module-example_code.graphs">
<spanid="example-code-graphs-module"></span><h2>example_code.graphs module<aclass="headerlink" href="#module-example_code.graphs" title="Link to this heading">¶</a></h2>
<p>A simple tree implementation with basic pre- and post-visitors.</p>
<dlclass="py class">
<dtclass="sig sig-object py" id="example_code.graphs.TreeNode">
<emclass="property"><spanclass="pre">class</span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">example_code.graphs.</span></span><spanclass="sig-name descname"><spanclass="pre">TreeNode</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">value</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">*</span></span><spanclass="n"><spanclass="pre">children</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/example_code/graphs.html#TreeNode"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#example_code.graphs.TreeNode" title="Link to this definition">¶</a></dt>
<dd><p>Bases: <aclass="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.14)"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">object</span></code></a></p>
<p>A basic tree implementation.</p>
<p>A tree is simply a collection of connected TreeNodes.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters<spanclass="colon">:</span></dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>value</strong> – An arbitrary value associated with this node.</p></li>
<li><p><strong>children</strong> – The TreeNodes which are the children of this node.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dlclass="py function">
<dtclass="sig sig-object py" id="example_code.graphs.postvisitor">
<spanclass="sig-prename descclassname"><spanclass="pre">example_code.graphs.</span></span><spanclass="sig-name descname"><spanclass="pre">postvisitor</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">tree</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">fn</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/example_code/graphs.html#postvisitor"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#example_code.graphs.postvisitor" title="Link to this definition">¶</a></dt>
<dd><p>Traverse tree in postorder applying a function to every node.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters<spanclass="colon">:</span></dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>tree</strong> (<aclass="reference internal" href="#example_code.graphs.TreeNode" title="example_code.graphs.TreeNode"><em>TreeNode</em></a>) – The tree to be visited.</p></li>
<li><p><strong>fn</strong> (<em>function</em><em>(</em><em>node</em><em>, </em><em>*fn_children</em><em>)</em>) – A function to be applied at each node. The function should take the
node to be visited as its first argument, and the results of
visiting its children as any further arguments.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dlclass="py function">
<dtclass="sig sig-object py" id="example_code.graphs.previsitor">
<spanclass="sig-prename descclassname"><spanclass="pre">example_code.graphs.</span></span><spanclass="sig-name descname"><spanclass="pre">previsitor</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">tree</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">fn</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">fn_parent</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/example_code/graphs.html#previsitor"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#example_code.graphs.previsitor" title="Link to this definition">¶</a></dt>
<dd><p>Traverse tree in preorder applying a function to every node.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters<spanclass="colon">:</span></dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>tree</strong> (<aclass="reference internal" href="#example_code.graphs.TreeNode" title="example_code.graphs.TreeNode"><em>TreeNode</em></a>) – The tree to be visited.</p></li>
<li><p><strong>fn</strong> (<em>function</em><em>(</em><em>node</em><em>, </em><em>fn_parent</em><em>)</em>) – A function to be applied at each node. The function should take
the node to be visited as its first argument, and the result of
visiting its parent as the second.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</section>
<sectionid="module-example_code.groups">
<spanid="example-code-groups-module"></span><h2>example_code.groups module<aclass="headerlink" href="#module-example_code.groups" title="Link to this heading">¶</a></h2>
<p>A module implementing the basic functionality of mathematical groups.</p>
<p>This version of the module uses inheritance.</p>
<dlclass="py class">
<dtclass="sig sig-object py" id="example_code.groups.CyclicGroup">
<emclass="property"><spanclass="pre">class</span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">example_code.groups.</span></span><spanclass="sig-name descname"><spanclass="pre">CyclicGroup</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">n</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/example_code/groups.html#CyclicGroup"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#example_code.groups.CyclicGroup" title="Link to this definition">¶</a></dt>
<dd><p>Bases: <aclass="reference internal" href="#example_code.groups.Group" title="example_code.groups.Group"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Group</span></code></a></p>
<p>A cyclic group represented by integer addition modulo n.</p>
<dlclass="py method">
<dtclass="sig sig-object py" id="example_code.groups.CyclicGroup.operation">
<spanclass="sig-name descname"><spanclass="pre">operation</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">a</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">b</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/example_code/groups.html#CyclicGroup.operation"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#example_code.groups.CyclicGroup.operation" title="Link to this definition">¶</a></dt>
<dd><p>Perform the group operation on two values.</p>
<p>The group operation is addition modulo n.</p>
</dd></dl>
<dlclass="py attribute">
<dtclass="sig sig-object py" id="example_code.groups.CyclicGroup.symbol">
<spanclass="sig-name descname"><spanclass="pre">symbol</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'C'</span></em><aclass="headerlink" href="#example_code.groups.CyclicGroup.symbol" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="py class">
<dtclass="sig sig-object py" id="example_code.groups.Element">
<emclass="property"><spanclass="pre">class</span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">example_code.groups.</span></span><spanclass="sig-name descname"><spanclass="pre">Element</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">group</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">value</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/example_code/groups.html#Element"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#example_code.groups.Element" title="Link to this definition">¶</a></dt>
<dd><p>Bases: <aclass="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.14)"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">object</span></code></a></p>
<p>An element of the specified group.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters<spanclass="colon">:</span></dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>group</strong> (<aclass="reference internal" href="#example_code.groups.Group" title="example_code.groups.Group"><em>Group</em></a>) – The group of which this is an element.</p></li>
<li><p><strong>value</strong> – The value of this entity. Valid values depend on the group.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dlclass="py class">
<dtclass="sig sig-object py" id="example_code.groups.GeneralLinearGroup">
<emclass="property"><spanclass="pre">class</span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">example_code.groups.</span></span><spanclass="sig-name descname"><spanclass="pre">GeneralLinearGroup</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">n</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/example_code/groups.html#GeneralLinearGroup"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#example_code.groups.GeneralLinearGroup" title="Link to this definition">¶</a></dt>
<dd><p>Bases: <aclass="reference internal" href="#example_code.groups.Group" title="example_code.groups.Group"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Group</span></code></a></p>
<p>The general linear group represented by n x n matrices.</p>
<dlclass="py method">
<dtclass="sig sig-object py" id="example_code.groups.GeneralLinearGroup.operation">
<spanclass="sig-name descname"><spanclass="pre">operation</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">a</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">b</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/example_code/groups.html#GeneralLinearGroup.operation"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#example_code.groups.GeneralLinearGroup.operation" title="Link to this definition">¶</a></dt>
<dd><p>Perform the group operation on two values.</p>
<p>The group operation is matrix multiplication.</p>
</dd></dl>
<dlclass="py attribute">
<dtclass="sig sig-object py" id="example_code.groups.GeneralLinearGroup.symbol">
<spanclass="sig-name descname"><spanclass="pre">symbol</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'G'</span></em><aclass="headerlink" href="#example_code.groups.GeneralLinearGroup.symbol" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="py class">
<dtclass="sig sig-object py" id="example_code.groups.Group">
<emclass="property"><spanclass="pre">class</span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">example_code.groups.</span></span><spanclass="sig-name descname"><spanclass="pre">Group</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">n</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/example_code/groups.html#Group"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#example_code.groups.Group" title="Link to this definition">¶</a></dt>
<dd><p>Bases: <aclass="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.14)"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">object</span></code></a></p>
<p>A base class containing methods common to many groups.</p>
<p>Each subclass represents a family of parametrised groups.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters<spanclass="colon">:</span></dt>
<ddclass="field-odd"><p><strong>n</strong> (<aclass="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</em></a>) – The primary group parameter, such as order or degree. The
precise meaning of n changes from subclass to subclass.</p>
</dd>
</dl>
</dd></dl>
</section>
<sectionid="module-example_code.groups_abc">
<spanid="example-code-groups-abc-module"></span><h2>example_code.groups_abc module<aclass="headerlink" href="#module-example_code.groups_abc" title="Link to this heading">¶</a></h2>
<p>A module implementing the basic functionality of mathematical groups.</p>
<p>This version of the module uses inheritance and defines the base class as an
<aclass="reference external" href="https://docs.python.org/3/library/abc.html#abc.ABC" title="(in Python v3.14)"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">abc.ABC</span></code></a>.</p>
<dlclass="py class">
<dtclass="sig sig-object py" id="example_code.groups_abc.CyclicGroup">
<emclass="property"><spanclass="pre">class</span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">example_code.groups_abc.</span></span><spanclass="sig-name descname"><spanclass="pre">CyclicGroup</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">n</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/example_code/groups_abc.html#CyclicGroup"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#example_code.groups_abc.CyclicGroup" title="Link to this definition">¶</a></dt>
<dd><p>Bases: <aclass="reference internal" href="#example_code.groups_abc.Group" title="example_code.groups_abc.Group"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Group</span></code></a></p>
<p>A cyclic group represented by integer addition modulo n.</p>
<dlclass="py method">
<dtclass="sig sig-object py" id="example_code.groups_abc.CyclicGroup.operation">
<spanclass="sig-name descname"><spanclass="pre">operation</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">a</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">b</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/example_code/groups_abc.html#CyclicGroup.operation"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#example_code.groups_abc.CyclicGroup.operation" title="Link to this definition">¶</a></dt>
<dd><p>Perform the group operation on two values.</p>
<p>The group operation is addition modulo n.</p>
</dd></dl>
<dlclass="py attribute">
<dtclass="sig sig-object py" id="example_code.groups_abc.CyclicGroup.symbol">
<spanclass="sig-name descname"><spanclass="pre">symbol</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'C'</span></em><aclass="headerlink" href="#example_code.groups_abc.CyclicGroup.symbol" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="py class">
<dtclass="sig sig-object py" id="example_code.groups_abc.Element">
<emclass="property"><spanclass="pre">class</span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">example_code.groups_abc.</span></span><spanclass="sig-name descname"><spanclass="pre">Element</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">group</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">value</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/example_code/groups_abc.html#Element"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#example_code.groups_abc.Element" title="Link to this definition">¶</a></dt>
<dd><p>Bases: <aclass="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.14)"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">object</span></code></a></p>
<p>An element of the specified group.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters<spanclass="colon">:</span></dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>group</strong> (<aclass="reference internal" href="#example_code.groups_abc.Group" title="example_code.groups_abc.Group"><em>Group</em></a>) – The group of which this is an element.</p></li>
<li><p><strong>value</strong> – The value of this entity. Valid values depend on the group.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dlclass="py class">
<dtclass="sig sig-object py" id="example_code.groups_abc.GeneralLinearGroup">
<emclass="property"><spanclass="pre">class</span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">example_code.groups_abc.</span></span><spanclass="sig-name descname"><spanclass="pre">GeneralLinearGroup</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">n</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/example_code/groups_abc.html#GeneralLinearGroup"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#example_code.groups_abc.GeneralLinearGroup" title="Link to this definition">¶</a></dt>
<dd><p>Bases: <aclass="reference internal" href="#example_code.groups_abc.Group" title="example_code.groups_abc.Group"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Group</span></code></a></p>
<p>The general linear group represented by n x n matrices.</p>
<dlclass="py method">
<dtclass="sig sig-object py" id="example_code.groups_abc.GeneralLinearGroup.operation">
<spanclass="sig-name descname"><spanclass="pre">operation</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">a</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">b</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/example_code/groups_abc.html#GeneralLinearGroup.operation"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#example_code.groups_abc.GeneralLinearGroup.operation" title="Link to this definition">¶</a></dt>
<dd><p>Perform the group operation on two values.</p>
<p>The group operation is matrix multiplication.</p>
</dd></dl>
<dlclass="py attribute">
<dtclass="sig sig-object py" id="example_code.groups_abc.GeneralLinearGroup.symbol">
<spanclass="sig-name descname"><spanclass="pre">symbol</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'G'</span></em><aclass="headerlink" href="#example_code.groups_abc.GeneralLinearGroup.symbol" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="py class">
<dtclass="sig sig-object py" id="example_code.groups_abc.Group">
<emclass="property"><spanclass="pre">class</span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">example_code.groups_abc.</span></span><spanclass="sig-name descname"><spanclass="pre">Group</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">n</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/example_code/groups_abc.html#Group"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#example_code.groups_abc.Group" title="Link to this definition">¶</a></dt>
<dd><p>Bases: <aclass="reference external" href="https://docs.python.org/3/library/abc.html#abc.ABC" title="(in Python v3.14)"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ABC</span></code></a></p>
<p>A base class containing methods common to many groups.</p>
<p>Each subclass represents a family of parametrised groups.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters<spanclass="colon">:</span></dt>
<ddclass="field-odd"><p><strong>n</strong> (<aclass="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</em></a>) – The primary group parameter, such as order or degree. The
precise meaning of n changes from subclass to subclass.</p>
</dd>
</dl>
<dlclass="py method">
<dtclass="sig sig-object py" id="example_code.groups_abc.Group.operation">
<emclass="property"><spanclass="pre">abstract</span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">operation</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">a</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">b</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/example_code/groups_abc.html#Group.operation"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#example_code.groups_abc.Group.operation" title="Link to this definition">¶</a></dt>
<dd><p>Return a ∘ b using the group operation ∘.</p>
</dd></dl>
<dlclass="py property">
<dtclass="sig sig-object py" id="example_code.groups_abc.Group.symbol">
<emclass="property"><spanclass="pre">abstract</span><spanclass="w"></span><spanclass="pre">property</span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">symbol</span></span><aclass="headerlink" href="#example_code.groups_abc.Group.symbol" title="Link to this definition">¶</a></dt>
<dd><p>Represent the group name as a character.</p>
</dd></dl>
</dd></dl>
</section>
<sectionid="module-example_code.groups_basic">
<spanid="example-code-groups-basic-module"></span><h2>example_code.groups_basic module<aclass="headerlink" href="#module-example_code.groups_basic" title="Link to this heading">¶</a></h2>
<p>A module implementing the basic functionality of mathematical groups.</p>
<dlclass="py class">
<dtclass="sig sig-object py" id="example_code.groups_basic.CyclicGroup">
<emclass="property"><spanclass="pre">class</span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">example_code.groups_basic.</span></span><spanclass="sig-name descname"><spanclass="pre">CyclicGroup</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">order</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/example_code/groups_basic.html#CyclicGroup"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#example_code.groups_basic.CyclicGroup" title="Link to this definition">¶</a></dt>
<dd><p>Bases: <aclass="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.14)"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">object</span></code></a></p>
<p>A cyclic group represented by addition modulo group order.</p>
<dlclass="py method">
<dtclass="sig sig-object py" id="example_code.groups_basic.CyclicGroup.operation">
<spanclass="sig-name descname"><spanclass="pre">operation</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">a</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">b</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/example_code/groups_basic.html#CyclicGroup.operation"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#example_code.groups_basic.CyclicGroup.operation" title="Link to this definition">¶</a></dt>
<dd><p>Perform the group operation on two values.</p>
<p>The group operation is addition modulo n.</p>
</dd></dl>
</dd></dl>
<dlclass="py class">
<dtclass="sig sig-object py" id="example_code.groups_basic.Element">
<emclass="property"><spanclass="pre">class</span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">example_code.groups_basic.</span></span><spanclass="sig-name descname"><spanclass="pre">Element</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">group</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">value</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/example_code/groups_basic.html#Element"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#example_code.groups_basic.Element" title="Link to this definition">¶</a></dt>
<dd><p>Bases: <aclass="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.14)"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">object</span></code></a></p>
<p>An element of the specified group.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters<spanclass="colon">:</span></dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>group</strong> – The group of which this is an element.</p></li>
<li><p><strong>value</strong> – The individual element value.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dlclass="py class">
<dtclass="sig sig-object py" id="example_code.groups_basic.GeneralLinearGroup">
<emclass="property"><spanclass="pre">class</span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">example_code.groups_basic.</span></span><spanclass="sig-name descname"><spanclass="pre">GeneralLinearGroup</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">degree</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/example_code/groups_basic.html#GeneralLinearGroup"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#example_code.groups_basic.GeneralLinearGroup" title="Link to this definition">¶</a></dt>
<dd><p>Bases: <aclass="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.14)"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">object</span></code></a></p>
<p>The general linear group represented by degree square matrices.</p>
<dlclass="py method">
<dtclass="sig sig-object py" id="example_code.groups_basic.GeneralLinearGroup.operation">
<spanclass="sig-name descname"><spanclass="pre">operation</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">a</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">b</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/example_code/groups_basic.html#GeneralLinearGroup.operation"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#example_code.groups_basic.GeneralLinearGroup.operation" title="Link to this definition">¶</a></dt>
<dd><p>Perform the group operation on two values.</p>
<p>The group operation is matrix multiplication.</p>
</dd></dl>
</dd></dl>
</section>
<sectionid="module-example_code.hello">
<spanid="example-code-hello-module"></span><h2>example_code.hello module<aclass="headerlink" href="#module-example_code.hello" title="Link to this heading">¶</a></h2>
</section>
<sectionid="module-example_code.linked_list">
<spanid="example-code-linked-list-module"></span><h2>example_code.linked_list module<aclass="headerlink" href="#module-example_code.linked_list" title="Link to this heading">¶</a></h2>
<dlclass="py class">
<dtclass="sig sig-object py" id="example_code.linked_list.Link">
<emclass="property"><spanclass="pre">class</span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">example_code.linked_list.</span></span><spanclass="sig-name descname"><spanclass="pre">Link</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">value</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">next</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/example_code/linked_list.html#Link"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#example_code.linked_list.Link" title="Link to this definition">¶</a></dt>
<dd><p>Bases: <aclass="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.14)"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">object</span></code></a></p>
<dlclass="py method">
<dtclass="sig sig-object py" id="example_code.linked_list.Link.insert">
<spanclass="sig-name descname"><spanclass="pre">insert</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">link</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/example_code/linked_list.html#Link.insert"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#example_code.linked_list.Link.insert" title="Link to this definition">¶</a></dt>
<dd><p>Insert a new link after the current one.</p>
</dd></dl>
</dd></dl>
<dlclass="py class">
<dtclass="sig sig-object py" id="example_code.linked_list.LinkIterator">
<emclass="property"><spanclass="pre">class</span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">example_code.linked_list.</span></span><spanclass="sig-name descname"><spanclass="pre">LinkIterator</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">link</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/example_code/linked_list.html#LinkIterator"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#example_code.linked_list.LinkIterator" title="Link to this definition">¶</a></dt>
<dd><p>Bases: <aclass="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.14)"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">object</span></code></a></p>
</dd></dl>
<dlclass="py function">
<dtclass="sig sig-object py" id="example_code.linked_list.byte_size">
<spanclass="sig-prename descclassname"><spanclass="pre">example_code.linked_list.</span></span><spanclass="sig-name descname"><spanclass="pre">byte_size</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">n</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/example_code/linked_list.html#byte_size"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#example_code.linked_list.byte_size" title="Link to this definition">¶</a></dt>
<dd><p>Print the size in bytes of lists up to length n.</p>
</dd></dl>
</section>
<sectionid="module-example_code.polynomial">
<spanid="example-code-polynomial-module"></span><h2>example_code.polynomial module<aclass="headerlink" href="#module-example_code.polynomial" title="Link to this heading">¶</a></h2>
<dlclass="py class">
<dtclass="sig sig-object py" id="example_code.polynomial.Polynomial">
<emclass="property"><spanclass="pre">class</span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">example_code.polynomial.</span></span><spanclass="sig-name descname"><spanclass="pre">Polynomial</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">coefs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/example_code/polynomial.html#Polynomial"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#example_code.polynomial.Polynomial" title="Link to this definition">¶</a></dt>
<dd><p>Bases: <aclass="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.14)"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">object</span></code></a></p>
<dlclass="py method">
<dtclass="sig sig-object py" id="example_code.polynomial.Polynomial.degree">
<spanclass="sig-name descname"><spanclass="pre">degree</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/example_code/polynomial.html#Polynomial.degree"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#example_code.polynomial.Polynomial.degree" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
</section>
<sectionid="module-example_code.shapes">
<spanid="example-code-shapes-module"></span><h2>example_code.shapes module<aclass="headerlink" href="#module-example_code.shapes" title="Link to this heading">¶</a></h2>
<p>A module containing some very simple shape classes to illustrate the use of
<codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">super()</span></code>.</p>
<dlclass="py class">
<dtclass="sig sig-object py" id="example_code.shapes.Rectangle">
<emclass="property"><spanclass="pre">class</span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">example_code.shapes.</span></span><spanclass="sig-name descname"><spanclass="pre">Rectangle</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">length</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">width</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/example_code/shapes.html#Rectangle"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#example_code.shapes.Rectangle" title="Link to this definition">¶</a></dt>
<dd><p>Bases: <aclass="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.14)"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">object</span></code></a></p>
<dlclass="py method">
<dtclass="sig sig-object py" id="example_code.shapes.Rectangle.area">
<spanclass="sig-name descname"><spanclass="pre">area</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/example_code/shapes.html#Rectangle.area"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#example_code.shapes.Rectangle.area" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="py class">
<dtclass="sig sig-object py" id="example_code.shapes.Square">
<emclass="property"><spanclass="pre">class</span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">example_code.shapes.</span></span><spanclass="sig-name descname"><spanclass="pre">Square</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">length</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/example_code/shapes.html#Square"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#example_code.shapes.Square" title="Link to this definition">¶</a></dt>
<dd><p>Bases: <aclass="reference internal" href="#example_code.shapes.Rectangle" title="example_code.shapes.Rectangle"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Rectangle</span></code></a></p>
</dd></dl>
</section>
<sectionid="module-example_code.simple_classes">
<spanid="example-code-simple-classes-module"></span><h2>example_code.simple_classes module<aclass="headerlink" href="#module-example_code.simple_classes" title="Link to this heading">¶</a></h2>
<p>A very elementary set of classes and objects for one of the week 3 quiz
questions.</p>
<dlclass="py class">
<dtclass="sig sig-object py" id="example_code.simple_classes.a">
<emclass="property"><spanclass="pre">class</span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">example_code.simple_classes.</span></span><spanclass="sig-name descname"><spanclass="pre">a</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">b</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/example_code/simple_classes.html#a"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#example_code.simple_classes.a" title="Link to this definition">¶</a></dt>
<dd><p>Bases: <aclass="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.14)"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">object</span></code></a></p>
<dlclass="py method">
<dtclass="sig sig-object py" id="example_code.simple_classes.a.c">
<spanclass="sig-name descname"><spanclass="pre">c</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/example_code/simple_classes.html#a.c"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#example_code.simple_classes.a.c" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="py attribute">
<dtclass="sig sig-object py" id="example_code.simple_classes.d">
<spanclass="sig-prename descclassname"><spanclass="pre">example_code.simple_classes.</span></span><spanclass="sig-name descname"><spanclass="pre">d</span></span><aclass="headerlink" href="#example_code.simple_classes.d" title="Link to this definition">¶</a></dt>
<dd><p>alias of <aclass="reference internal" href="#example_code.simple_classes.a" title="example_code.simple_classes.a"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">a</span></code></a></p>
</dd></dl>
<dlclass="py function">
<dtclass="sig sig-object py" id="example_code.simple_classes.g">
<spanclass="sig-prename descclassname"><spanclass="pre">example_code.simple_classes.</span></span><spanclass="sig-name descname"><spanclass="pre">g</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#example_code.simple_classes.g" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
</section>
<sectionid="module-example_code.square">
<spanid="example-code-square-module"></span><h2>example_code.square module<aclass="headerlink" href="#module-example_code.square" title="Link to this heading">¶</a></h2>
<dlclass="py function">
<dtclass="sig sig-object py" id="example_code.square.square">
<spanclass="sig-prename descclassname"><spanclass="pre">example_code.square.</span></span><spanclass="sig-name descname"><spanclass="pre">square</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">x</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/example_code/square.html#square"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#example_code.square.square" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
</section>
<sectionid="module-example_code.try_except">
<spanid="example-code-try-except-module"></span><h2>example_code.try_except module<aclass="headerlink" href="#module-example_code.try_except" title="Link to this heading">¶</a></h2>
<dlclass="py function">
<dtclass="sig sig-object py" id="example_code.try_except.except_demo">
<spanclass="sig-prename descclassname"><spanclass="pre">example_code.try_except.</span></span><spanclass="sig-name descname"><spanclass="pre">except_demo</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">n</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="_modules/example_code/try_except.html#except_demo"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#example_code.try_except.except_demo" title="Link to this definition">¶</a></dt>
<dd><p>Demonstrate all the clauses of a <codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">try</span></code> block.</p>
</dd></dl>
</section>
<sectionid="module-example_code">
<spanid="module-contents"></span><h2>Module contents<aclass="headerlink" href="#module-example_code" title="Link to this heading">¶</a></h2>
</section>
</section>
<divclass="clearer"></div>
</div>
</div>
</div>
<divclass="clearer"></div>
</div>
<divclass="footer" role="contentinfo">
© Copyright 2019-2023, David A. Ham.
Created using <ahref="https://www.sphinx-doc.org/">Sphinx</a> 7.4.7.
</div>
</body>
</html>