docs/szyfrow/support/index.html

   1 <!doctype html>
   2 <html lang="en">
   3 <head>
   4 <meta charset="utf-8">
   5 <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
   6 <meta name="generator" content="pdoc 0.9.2" />
   7 <title>szyfrow.support API documentation</title>
   8 <meta name="description" content="Support utilities for ciphers …" />
   9 <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>
  10 <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>
  11 <link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
  12 <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>
  13 <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>
  14 <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>
  15 <script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
  16 <script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
  17 </head>
  18 <body>
  19 <main>
  20 <article id="content">
  21 <header>
  22 <h1 class="title">Module <code>szyfrow.support</code></h1>
  23 </header>
  24 <section id="section-intro">
  25 <p>Support utilities for ciphers. </p>
  26 <p>Language models are for understanding what English looks like, for help with
  27 cipher breaking.</p>
  28 <p>Text prettify is various procedures for pretty-printing text, such as
  29 segmenting text into words.</p>
  30 <p>Utilities are general utility functions.</p>
  31 <details class="source">
  32 <summary>
  33 <span>Expand source code</span>
  34 </summary>
  35 <pre><code class="python">&#34;&#34;&#34;Support utilities for ciphers.
  36
  37 Language models are for understanding what English looks like, for help with
  38 cipher breaking.
  39
  40 Text prettify is various procedures for pretty-printing text, such as
  41 segmenting text into words.
  42
  43 Utilities are general utility functions.
  44 &#34;&#34;&#34;</code></pre>
  45 </details>
  46 </section>
  47 <section>
  48 <h2 class="section-title" id="header-submodules">Sub-modules</h2>
  49 <dl>
  50 <dt><code class="name"><a title="szyfrow.support.language_models" href="language_models.html">szyfrow.support.language_models</a></code></dt>
  51 <dd>
  52 <div class="desc"><p>Descriptive models of a natural language (in this case, English) …</p></div>
  53 </dd>
  54 <dt><code class="name"><a title="szyfrow.support.norms" href="norms.html">szyfrow.support.norms</a></code></dt>
  55 <dd>
  56 <div class="desc"><p>Various norms, for calcuating the distances between two frequency
  57 profiles.</p></div>
  58 </dd>
  59 <dt><code class="name"><a title="szyfrow.support.segment" href="segment.html">szyfrow.support.segment</a></code></dt>
  60 <dd>
  61 <div class="desc"><p>Setments a string of characters into words, following a language model …</p></div>
  62 </dd>
  63 <dt><code class="name"><a title="szyfrow.support.text_prettify" href="text_prettify.html">szyfrow.support.text_prettify</a></code></dt>
  64 <dd>
  65 <div class="desc"><p>Various functions for prettifying text, useful when cipher routines generate
  66 strings of letters without spaces.</p></div>
  67 </dd>
  68 <dt><code class="name"><a title="szyfrow.support.utilities" href="utilities.html">szyfrow.support.utilities</a></code></dt>
  69 <dd>
  70 <div class="desc"><p>A mish-mash of utility functions</p></div>
  71 </dd>
  72 </dl>
  73 </section>
  74 <section>
  75 </section>
  76 <section>
  77 </section>
  78 <section>
  79 </section>
  80 </article>
  81 <nav id="sidebar">
  82 <h1>Index</h1>
  83 <div class="toc">
  84 <ul></ul>
  85 </div>
  86 <ul id="index">
  87 <li><h3>Super-module</h3>
  88 <ul>
  89 <li><code><a title="szyfrow" href="../index.html">szyfrow</a></code></li>
  90 </ul>
  91 </li>
  92 <li><h3><a href="#header-submodules">Sub-modules</a></h3>
  93 <ul>
  94 <li><code><a title="szyfrow.support.language_models" href="language_models.html">szyfrow.support.language_models</a></code></li>
  95 <li><code><a title="szyfrow.support.norms" href="norms.html">szyfrow.support.norms</a></code></li>
  96 <li><code><a title="szyfrow.support.segment" href="segment.html">szyfrow.support.segment</a></code></li>
  97 <li><code><a title="szyfrow.support.text_prettify" href="text_prettify.html">szyfrow.support.text_prettify</a></code></li>
  98 <li><code><a title="szyfrow.support.utilities" href="utilities.html">szyfrow.support.utilities</a></code></li>
  99 </ul>
 100 </li>
 101 </ul>
 102 </nav>
 103 </main>
 104 <footer id="footer">
 105 <p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.2</a>.</p>
 106 </footer>
 107 </body>
 108 </html>