Auto-generate VicUtils documentation [skip ci]

Vic-Nas · Vic-Nas · commit a6fa75cbaf2b · 2025-11-08T05:03:25.000Z
diff --git a/vicutils/printBin.html b/vicutils/printBin.html
@@ -0,0 +1,393 @@
+<!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="pdoc3 0.11.6">
+<title>printBin API documentation</title>
+<meta name="description" content="">
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
+<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;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:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 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 .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#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-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;min-width:max-content}.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 1em;margin:1em 0}.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}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.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/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
+<script>window.addEventListener('DOMContentLoaded', () => {
+hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
+hljs.highlightAll();
+/* Collapse source docstrings */
+setTimeout(() => {
+[...document.querySelectorAll('.hljs.language-python > .hljs-string')]
+.filter(el => el.innerHTML.length > 200 && ['"""', "'''"].includes(el.innerHTML.substring(0, 3)))
+.forEach(el => {
+let d = document.createElement('details');
+d.classList.add('hljs-string');
+d.innerHTML = '<summary>"""</summary>' + el.innerHTML.substring(3);
+el.replaceWith(d);
+});
+}, 100);
+})</script>
+</head>
+<body>
+<main>
+<article id="content">
+<header>
+<h1 class="title">Module <code>printBin</code></h1>
+</header>
+<section id="section-intro">
+</section>
+<section>
+</section>
+<section>
+</section>
+<section>
+<h2 class="section-title" id="header-functions">Functions</h2>
+<dl>
+<dt id="printBin.center"><code class="name flex">
+<span>def <span class="ident">center</span></span>(<span>val, unitSize=None, fillChar=None)</span>
+</code></dt>
+<dd>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">def center(val, unitSize=None, fillChar=None):
+    &#34;&#34;&#34;
+    Centers a value within a fixed width string.
+    
+    Args:
+        val: The value to center
+        unitSize: The total width of the output string (uses DEFAULT_UNIT_SIZE if None)
+        fillChar: The character to use for padding (uses DEFAULT_FILL_CHAR if None)
+        
+    Returns:
+        A centered string representation of val
+    &#34;&#34;&#34;
+    if unitSize is None:
+        unitSize = DEFAULT_UNIT_SIZE
+    if fillChar is None:
+        fillChar = DEFAULT_FILL_CHAR
+    return str(val).center(unitSize, fillChar)</code></pre>
+</details>
+<div class="desc"><p>Centers a value within a fixed width string.</p>
+<h2 id="args">Args</h2>
+<dl>
+<dt><strong><code>val</code></strong></dt>
+<dd>The value to center</dd>
+<dt><strong><code>unitSize</code></strong></dt>
+<dd>The total width of the output string (uses DEFAULT_UNIT_SIZE if None)</dd>
+<dt><strong><code>fillChar</code></strong></dt>
+<dd>The character to use for padding (uses DEFAULT_FILL_CHAR if None)</dd>
+</dl>
+<h2 id="returns">Returns</h2>
+<p>A centered string representation of val</p></div>
+</dd>
+<dt id="printBin.getDepth"><code class="name flex">
+<span>def <span class="ident">getDepth</span></span>(<span>node: <a title="printBin.Node" href="#printBin.Node">Node</a>)</span>
+</code></dt>
+<dd>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">def getDepth(node: Node):
+    &#34;&#34;&#34;
+    Calculates the depth (height) of a binary tree.
+    
+    Args:
+        node: The root node of the tree
+        
+    Returns:
+        The depth of the tree (number of levels from root to deepest leaf)
+    &#34;&#34;&#34;
+    if node == None:
+        return 0
+    return 1 + max(getDepth(node.left), getDepth(node.right))</code></pre>
+</details>
+<div class="desc"><p>Calculates the depth (height) of a binary tree.</p>
+<h2 id="args">Args</h2>
+<dl>
+<dt><strong><code>node</code></strong></dt>
+<dd>The root node of the tree</dd>
+</dl>
+<h2 id="returns">Returns</h2>
+<p>The depth of the tree (number of levels from root to deepest leaf)</p></div>
+</dd>
+<dt id="printBin.nodeToMat"><code class="name flex">
+<span>def <span class="ident">nodeToMat</span></span>(<span>node: <a title="printBin.Node" href="#printBin.Node">Node</a>,<br>depth=-1,<br>fillChar=None,<br>unitSize=None,<br>removeEmpty=True)</span>
+</code></dt>
+<dd>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">def nodeToMat(node: Node, depth=-1, fillChar=None, unitSize=None, removeEmpty=True):
+    &#34;&#34;&#34;
+    Converts a binary tree into a 2D matrix representation for visualization.
+    
+    The matrix includes:
+    - Even rows (0, 2, 4...): Node values
+    - Odd rows (1, 3, 5...): Connection lines (/ and \\)
+    
+    Args:
+        node: The root node of the tree to visualize
+        depth: The depth of the tree (-1 for auto-calculation)
+        fillChar: Character for padding (uses DEFAULT_FILL_CHAR if None)
+        unitSize: Size for centering (uses DEFAULT_UNIT_SIZE if None)
+        removeEmpty: Whether to remove empty leading columns
+        
+    Returns:
+        A 2D list (matrix) representing the tree structure
+    &#34;&#34;&#34;
+    if unitSize is None:
+        unitSize = DEFAULT_UNIT_SIZE
+    if fillChar is None:
+        fillChar = DEFAULT_FILL_CHAR
+    
+    if depth == -1:
+        depth = getDepth(node)
+    
+    # Register all nodes with their binary path codes
+    tree = register(node, fillChar=fillChar, unitSize=unitSize, code=&#34;&#34;, mem={})
+    
+    # Create matrix: (2*depth - 1) rows x (2^depth - 1) columns
+    mat = [[center(&#34;&#34;, unitSize=unitSize, fillChar=fillChar) for _ in range(2 ** depth - 1)] for _ in range(2 * depth - 1)]
+    
+    side = &#34;left&#34;
+    leftBound, rightBound = 0, 2 ** depth - 2
+    
+    # Start with all even column indices (where values can be placed)
+    valueIndexes = [i for i in range(2 ** depth - 1) if i % 2 == 0]
+    
+    # Build matrix from bottom to top
+    for level in range(2 * (depth - 1), -1, -1):
+        # Odd levels: place connection characters (/ and \)
+        if level % 2 != 0:
+            for i, index in enumerate(valueIndexes):
+                mat[level][index] = [center(&#34;/&#34;, unitSize=unitSize, fillChar=fillChar), center(&#34;\\&#34;, unitSize=unitSize, fillChar=fillChar)][i % 2]
+            
+            # Calculate parent positions (midpoints between child pairs)
+            newIndexes = []
+            for i in range(0, len(valueIndexes) - 1, 2):
+                newIndexes.append((valueIndexes[i] + valueIndexes[i + 1]) // 2)
+            valueIndexes = newIndexes
+            continue
+        
+        # Even levels: place node values
+        # Generate all binary codes for current level
+        codes = list(product(*[&#34;01&#34; for _ in range(level // 2)]))
+        codes = [&#34;&#34;.join(code) for code in codes]
+        
+        for i, index in enumerate(valueIndexes):
+            mat[level][index] = tree.get(codes[i], center(&#34;&#34;, unitSize=unitSize, fillChar=fillChar))
+    
+    # Remove empty leading columns if requested
+    if removeEmpty:
+        for i in range(2 ** depth - 1):
+            remove = False
+            if all(
+                mat[j][i] in [
+                    center(&#34;&#34;, unitSize=unitSize, fillChar=fillChar),
+                    center(&#34;/&#34;, unitSize=unitSize, fillChar=fillChar),
+                    center(&#34;\\&#34;, unitSize=unitSize, fillChar=fillChar)
+                ] for j in range(2 * depth - 1)
+            ):
+                remove = True
+            if not remove:
+                break
+            for j in range(2 * depth - 1):
+                mat[j][i] = &#34;&#34;
+    
+    return mat</code></pre>
+</details>
+<div class="desc"><p>Converts a binary tree into a 2D matrix representation for visualization.</p>
+<p>The matrix includes:
+- Even rows (0, 2, 4&hellip;): Node values
+- Odd rows (1, 3, 5&hellip;): Connection lines (/ and )</p>
+<h2 id="args">Args</h2>
+<dl>
+<dt><strong><code>node</code></strong></dt>
+<dd>The root node of the tree to visualize</dd>
+<dt><strong><code>depth</code></strong></dt>
+<dd>The depth of the tree (-1 for auto-calculation)</dd>
+<dt><strong><code>fillChar</code></strong></dt>
+<dd>Character for padding (uses DEFAULT_FILL_CHAR if None)</dd>
+<dt><strong><code>unitSize</code></strong></dt>
+<dd>Size for centering (uses DEFAULT_UNIT_SIZE if None)</dd>
+<dt><strong><code>removeEmpty</code></strong></dt>
+<dd>Whether to remove empty leading columns</dd>
+</dl>
+<h2 id="returns">Returns</h2>
+<p>A 2D list (matrix) representing the tree structure</p></div>
+</dd>
+<dt id="printBin.nodeToString"><code class="name flex">
+<span>def <span class="ident">nodeToString</span></span>(<span>node: <a title="printBin.Node" href="#printBin.Node">Node</a>,<br>depth=-1,<br>fillChar=None,<br>unitSize=None,<br>removeEmpty=True)</span>
+</code></dt>
+<dd>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">def nodeToString(node: Node, depth=-1, fillChar=None, unitSize=None, removeEmpty=True):
+    &#34;&#34;&#34;
+    Converts a binary tree into a string representation for visualization.
+    
+    Args:
+        node: The root node of the tree to visualize
+        depth: The depth of the tree (-1 for auto-calculation)
+        fillChar: Character for padding (uses DEFAULT_FILL_CHAR if None)
+        unitSize: Size for centering (uses DEFAULT_UNIT_SIZE if None)
+        removeEmpty: Whether to remove empty leading columns
+        
+    Returns:
+        A string representation of the tree with each row on a new line
+    &#34;&#34;&#34;
+    mat = nodeToMat(node, depth=depth, fillChar=fillChar, unitSize=unitSize, removeEmpty=removeEmpty)
+    return &#34;\n&#34;.join(&#34;&#34;.join(row) for row in mat)</code></pre>
+</details>
+<div class="desc"><p>Converts a binary tree into a string representation for visualization.</p>
+<h2 id="args">Args</h2>
+<dl>
+<dt><strong><code>node</code></strong></dt>
+<dd>The root node of the tree to visualize</dd>
+<dt><strong><code>depth</code></strong></dt>
+<dd>The depth of the tree (-1 for auto-calculation)</dd>
+<dt><strong><code>fillChar</code></strong></dt>
+<dd>Character for padding (uses DEFAULT_FILL_CHAR if None)</dd>
+<dt><strong><code>unitSize</code></strong></dt>
+<dd>Size for centering (uses DEFAULT_UNIT_SIZE if None)</dd>
+<dt><strong><code>removeEmpty</code></strong></dt>
+<dd>Whether to remove empty leading columns</dd>
+</dl>
+<h2 id="returns">Returns</h2>
+<p>A string representation of the tree with each row on a new line</p></div>
+</dd>
+<dt id="printBin.register"><code class="name flex">
+<span>def <span class="ident">register</span></span>(<span>node: <a title="printBin.Node" href="#printBin.Node">Node</a>,<br>fillChar=None,<br>unitSize=None,<br>code='',<br>mem=None)</span>
+</code></dt>
+<dd>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">def register(node: Node, fillChar=None, unitSize=None, code=&#34;&#34;, mem=None):
+    &#34;&#34;&#34;
+    Recursively registers all nodes in a tree with their binary path codes.
+    
+    Each node is assigned a binary code representing its position:
+    - Empty string &#34;&#34; for root
+    - &#34;0&#34; appended for left child
+    - &#34;1&#34; appended for right child
+    
+    Args:
+        node: The current node being processed
+        fillChar: Character used for padding (uses DEFAULT_FILL_CHAR if None)
+        unitSize: Size for centering values (uses DEFAULT_UNIT_SIZE if None)
+        code: The binary path code for the current node
+        mem: Dictionary mapping binary codes to centered node values
+    &#34;&#34;&#34;
+    if mem is None:
+        mem = {}
+    if node:
+        mem[code] = center(node.val, unitSize=unitSize, fillChar=fillChar)
+        register(node.left, fillChar=fillChar, unitSize=unitSize, code=code + &#34;0&#34;, mem=mem)
+        register(node.right, fillChar=fillChar, unitSize=unitSize, code=code + &#34;1&#34;, mem=mem)
+    return mem</code></pre>
+</details>
+<div class="desc"><p>Recursively registers all nodes in a tree with their binary path codes.</p>
+<p>Each node is assigned a binary code representing its position:
+- Empty string "" for root
+- "0" appended for left child
+- "1" appended for right child</p>
+<h2 id="args">Args</h2>
+<dl>
+<dt><strong><code>node</code></strong></dt>
+<dd>The current node being processed</dd>
+<dt><strong><code>fillChar</code></strong></dt>
+<dd>Character used for padding (uses DEFAULT_FILL_CHAR if None)</dd>
+<dt><strong><code>unitSize</code></strong></dt>
+<dd>Size for centering values (uses DEFAULT_UNIT_SIZE if None)</dd>
+<dt><strong><code>code</code></strong></dt>
+<dd>The binary path code for the current node</dd>
+<dt><strong><code>mem</code></strong></dt>
+<dd>Dictionary mapping binary codes to centered node values</dd>
+</dl></div>
+</dd>
+</dl>
+</section>
+<section>
+<h2 class="section-title" id="header-classes">Classes</h2>
+<dl>
+<dt id="printBin.Node"><code class="flex name class">
+<span>class <span class="ident">Node</span></span>
+<span>(</span><span>val=0, left=None, right=None)</span>
+</code></dt>
+<dd>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">class Node:
+    &#34;&#34;&#34;
+    Represents a node in a binary tree.
+    
+    Attributes:
+        val: The value stored in the node
+        left: Reference to the left child node
+        right: Reference to the right child node
+    &#34;&#34;&#34;
+    def __init__(self, val=0, left=None, right=None):
+        self.val = val
+        self.left = left
+        self.right = right
+    
+    def __str__(self):
+        return str(self.val)
+    
+    def __repr__(self):
+        return str(self)</code></pre>
+</details>
+<div class="desc"><p>Represents a node in a binary tree.</p>
+<h2 id="attributes">Attributes</h2>
+<dl>
+<dt><strong><code>val</code></strong></dt>
+<dd>The value stored in the node</dd>
+<dt><strong><code>left</code></strong></dt>
+<dd>Reference to the left child node</dd>
+<dt><strong><code>right</code></strong></dt>
+<dd>Reference to the right child node</dd>
+</dl></div>
+</dd>
+</dl>
+</section>
+</article>
+<nav id="sidebar">
+<div class="toc">
+<ul></ul>
+</div>
+<ul id="index">
+<li><h3><a href="#header-functions">Functions</a></h3>
+<ul class="">
+<li><code><a title="printBin.center" href="#printBin.center">center</a></code></li>
+<li><code><a title="printBin.getDepth" href="#printBin.getDepth">getDepth</a></code></li>
+<li><code><a title="printBin.nodeToMat" href="#printBin.nodeToMat">nodeToMat</a></code></li>
+<li><code><a title="printBin.nodeToString" href="#printBin.nodeToString">nodeToString</a></code></li>
+<li><code><a title="printBin.register" href="#printBin.register">register</a></code></li>
+</ul>
+</li>
+<li><h3><a href="#header-classes">Classes</a></h3>
+<ul>
+<li>
+<h4><code><a title="printBin.Node" href="#printBin.Node">Node</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.11.6</a>.</p>
+</footer>
+</body>
+</html>
