jarjonam
/
tidal_tails


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142
							<!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.5.2" />
<title>utils API documentation</title>
<meta name="description" content="Short utility functions for use elsewhere" />
<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.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%}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{font-weight:bold}#index h4 + ul{margin-bottom:.6em}#index .two-column{column-count:2}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}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.name small{font-weight:normal}.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{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase;cursor:pointer}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{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%}.admonition{padding:.1em .5em}.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%}#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>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title"><code>utils</code> module</h1>
</header>
<section id="section-intro">
<p>Short utility functions for use elsewhere</p>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">&#34;&#34;&#34;Short utility functions for use elsewhere&#34;&#34;&#34;

import numpy as np

def update_config(default, update):
    &#34;&#34;&#34;Recursively updates a Python (configuration) dictionary&#34;&#34;&#34;
    for key in update: 
        if isinstance(default[key], dict): #Recurse if it is a dictionary
            update_config(default[key], update[key])
        else: default[key] = update[key] #Simply copy the value otherwise

def random_unit_vectors(size, mode=&#39;3D&#39;):
    &#34;&#34;&#34;Draws an array of size size corresponding to isotropically distributed
    random unit vectors (number of vectors, dimension). If mode is 2D, the
    vectors are instead distributed isotropically on the xy plane.&#34;&#34;&#34;
    direction = np.random.normal(size=(size, 3))
    if mode == &#39;2D&#39;: direction[:, -1] = 0
    return direction / np.linalg.norm(direction, axis=-1, keepdims=True)

def cascade_round(arr):
    &#34;&#34;&#34;Rounds the floats in an array to integers while preserving their total
    sum (as closely as possible). Follows the cascade rounding algorithm.&#34;&#34;&#34;
    runningSurplus = 0
    for i in range(len(arr)):
        f = arr[i] + runningSurplus
        arr[i] = int(np.round(f))
        runningSurplus = f - arr[i]
    return arr</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-functions">Functions</h2>
<dl>
<dt id="utils.cascade_round"><code class="name flex">
<span>def <span class="ident">cascade_round</span></span>(<span>arr)</span>
</code></dt>
<dd>
<section class="desc"><p>Rounds the floats in an array to integers while preserving their total
sum (as closely as possible). Follows the cascade rounding algorithm.</p></section>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">def cascade_round(arr):
    &#34;&#34;&#34;Rounds the floats in an array to integers while preserving their total
    sum (as closely as possible). Follows the cascade rounding algorithm.&#34;&#34;&#34;
    runningSurplus = 0
    for i in range(len(arr)):
        f = arr[i] + runningSurplus
        arr[i] = int(np.round(f))
        runningSurplus = f - arr[i]
    return arr</code></pre>
</details>
</dd>
<dt id="utils.random_unit_vectors"><code class="name flex">
<span>def <span class="ident">random_unit_vectors</span></span>(<span>size, mode=&#39;3D&#39;)</span>
</code></dt>
<dd>
<section class="desc"><p>Draws an array of size size corresponding to isotropically distributed
random unit vectors (number of vectors, dimension). If mode is 2D, the
vectors are instead distributed isotropically on the xy plane.</p></section>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">def random_unit_vectors(size, mode=&#39;3D&#39;):
    &#34;&#34;&#34;Draws an array of size size corresponding to isotropically distributed
    random unit vectors (number of vectors, dimension). If mode is 2D, the
    vectors are instead distributed isotropically on the xy plane.&#34;&#34;&#34;
    direction = np.random.normal(size=(size, 3))
    if mode == &#39;2D&#39;: direction[:, -1] = 0
    return direction / np.linalg.norm(direction, axis=-1, keepdims=True)</code></pre>
</details>
</dd>
<dt id="utils.update_config"><code class="name flex">
<span>def <span class="ident">update_config</span></span>(<span>default, update)</span>
</code></dt>
<dd>
<section class="desc"><p>Recursively updates a Python (configuration) dictionary</p></section>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">def update_config(default, update):
    &#34;&#34;&#34;Recursively updates a Python (configuration) dictionary&#34;&#34;&#34;
    for key in update: 
        if isinstance(default[key], dict): #Recurse if it is a dictionary
            update_config(default[key], update[key])
        else: default[key] = update[key] #Simply copy the value otherwise</code></pre>
</details>
</dd>
</dl>
</section>
<section>
</section>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3><a href="#header-functions">Functions</a></h3>
<ul class="">
<li><code><a title="utils.cascade_round" href="#utils.cascade_round">cascade_round</a></code></li>
<li><code><a title="utils.random_unit_vectors" href="#utils.random_unit_vectors">random_unit_vectors</a></code></li>
<li><code><a title="utils.update_config" href="#utils.update_config">update_config</a></code></li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.5.2</a>.</p>
</footer>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad()</script>
</body>
</html>