407 lines
12 KiB
HTML
407 lines
12 KiB
HTML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
|
"DTD/xhtml1-strict.dtd">
|
|
<html>
|
|
|
|
|
|
<head>
|
|
|
|
<title>fn_gen.enums.sweep_spacing.SweepSpacing</title>
|
|
<meta name="generator" content="pydoctor 23.9.1">
|
|
|
|
</meta>
|
|
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1 maximum-scale=1" />
|
|
<link rel="stylesheet" type="text/css" href="bootstrap.min.css" />
|
|
<link rel="stylesheet" type="text/css" href="apidocs.css" />
|
|
<link rel="stylesheet" type="text/css" href="extra.css" />
|
|
</head>
|
|
|
|
<body>
|
|
|
|
|
|
|
|
<nav class="navbar navbar-default mainnavbar">
|
|
|
|
|
|
<div class="container-fluid">
|
|
|
|
|
|
<div class="navbar-header">
|
|
|
|
<div class="navlinks">
|
|
<span class="navbar-brand">
|
|
fn_gen <a href="index.html">API Documentation</a>
|
|
</span>
|
|
|
|
<a href="moduleIndex.html">
|
|
Modules
|
|
</a>
|
|
|
|
<a href="classIndex.html">
|
|
Classes
|
|
</a>
|
|
|
|
<a href="nameIndex.html">
|
|
Names
|
|
</a>
|
|
|
|
<div id="search-box-container">
|
|
<div class="input-group">
|
|
<input id="search-box" type="search" name="search-query" placeholder="Search..." aria-label="Search" minlength="2" class="form-control" autocomplete="off" />
|
|
|
|
<span class="input-group-btn">
|
|
<a style="display: none;" class="btn btn-default" id="search-clear-button" title="Clear" onclick="clearSearch()"><img src="fonts/x-circle.svg" alt="Clear" /></a>
|
|
<a class="btn btn-default" id="search-help-button" title="Help" onclick="toggleSearchHelpText()"><img src="fonts/info.svg" alt="Help" /></a>
|
|
</span>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div id="search-results-container" style="display: none;">
|
|
|
|
<div id="search-buttons">
|
|
<span class="label label-default" id="search-docstrings-button">
|
|
<label class="checkbox-inline">
|
|
<input type="checkbox" id="toggle-search-in-docstrings-checkbox" value="false" onclick="toggleSearchInDocstrings()">
|
|
search in docstrings
|
|
</input>
|
|
</label>
|
|
</span>
|
|
|
|
</div>
|
|
|
|
<noscript>
|
|
<h1>Cannot search: JavaScript is not supported/enabled in your browser.</h1>
|
|
</noscript>
|
|
|
|
<div class="hint" id="search-help-box">
|
|
<p class="rst-last">
|
|
|
|
Search bar offers the following options:
|
|
<ul>
|
|
<li>
|
|
<strong>Term presence.</strong> The below example searches for documents that
|
|
must contain “foo”, might contain “bar” and must not contain “baz”: <code>+foo bar -baz</code>
|
|
</li>
|
|
|
|
<li>
|
|
<strong>Wildcards.</strong> The below example searches for documents with words beginning with “foo”: <code>foo*</code>
|
|
</li>
|
|
|
|
<li>
|
|
<strong>Search in specific fields.</strong> The following search matches all objects
|
|
in "twisted.mail" that matches “search”: <code>+qname:twisted.mail.* +search</code>
|
|
|
|
<p>
|
|
Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'.
|
|
Last two fields are only applicable if "search in docstrings" is enabled.
|
|
</p>
|
|
</li>
|
|
|
|
<li>
|
|
<strong>Fuzzy matches.</strong> The following search matches all documents
|
|
that have a word within 1 edit distance of “foo”: <code>foo~1</code>
|
|
</li>
|
|
</ul>
|
|
|
|
</p>
|
|
</div>
|
|
|
|
<div id="search-status"> </div>
|
|
|
|
<div class="warning" id="search-warn-box" style="display: none;">
|
|
<p class="rst-last"><span id="search-warn"></span></p>
|
|
</div>
|
|
|
|
<table id="search-results">
|
|
<!-- Filled dynamically by JS -->
|
|
</table>
|
|
|
|
<div style="margin-top: 8px;">
|
|
<p>Results provided by <a href="https://lunrjs.com">Lunr.js</a></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</nav>
|
|
|
|
<div class="container-fluid">
|
|
|
|
<!-- Side navigation -->
|
|
<div class="sidebarcontainer" style="display: none;">
|
|
|
|
<div class="sidebar"><nav class="sidebar">
|
|
|
|
|
|
<div>
|
|
|
|
<div class="thingTitle">
|
|
<span>Class</span>
|
|
<code class="thisobject"><a href="fn_gen.enums.sweep_spacing.SweepSpacing.html" class="internal-link" title="This class"><wbr></wbr>Sweep<wbr></wbr>Spacing</a></code>
|
|
</div>
|
|
|
|
<div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="childrenKindTitle">Attributes</div>
|
|
<ul>
|
|
|
|
<li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="#LIN" class="internal-link" title="fn_gen.enums.sweep_spacing.SweepSpacing.LIN">LIN</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="#LOG" class="internal-link" title="fn_gen.enums.sweep_spacing.SweepSpacing.LOG">LOG</a></code>
|
|
</div>
|
|
|
|
|
|
</li><li class="">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="#STEP" class="internal-link" title="fn_gen.enums.sweep_spacing.SweepSpacing.STEP">STEP</a></code>
|
|
</div>
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div><div>
|
|
|
|
<div class="thingTitle">
|
|
<span>Module</span>
|
|
<code><a href="fn_gen.enums.sweep_spacing.html" class="internal-link" title="The parent of this class">sweep<wbr></wbr>_spacing</a></code>
|
|
</div>
|
|
|
|
<div>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="childrenKindTitle">Classes</div>
|
|
<ul>
|
|
|
|
<li class=" thisobject">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="itemName"><code><a href="fn_gen.enums.sweep_spacing.SweepSpacing.html" class="internal-link" title="fn_gen.enums.sweep_spacing.SweepSpacing"><wbr></wbr>Sweep<wbr></wbr>Spacing</a></code>
|
|
</div>
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</nav>
|
|
</div>
|
|
<div id="collapseSideBar">
|
|
<a class="btn btn-link" onclick="toggleSideBarCollapse()" title="Toggle Sidebar Collapse">
|
|
</a>
|
|
</div>
|
|
<script src="sidebartoggle.js" type="text/javascript"></script>
|
|
|
|
</div>
|
|
|
|
<div id="main" class="">
|
|
|
|
|
|
|
|
|
|
<div class="page-header">
|
|
<h1 class="class"><code><code><a href="index.html" class="internal-link">fn_gen</a></code><wbr></wbr>.<code><a href="fn_gen.enums.html" class="internal-link" title="fn_gen.enums">enums</a></code><wbr></wbr>.<code><a href="fn_gen.enums.sweep_spacing.html" class="internal-link" title="fn_gen.enums.sweep_spacing">sweep_spacing</a></code><wbr></wbr>.<code><a href="fn_gen.enums.sweep_spacing.SweepSpacing.html" class="internal-link" title="fn_gen.enums.sweep_spacing.SweepSpacing">SweepSpacing</a></code></code></h1>
|
|
<div id="showPrivate">
|
|
<button class="btn btn-link" onclick="togglePrivate()">Toggle Private API</button>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="categoryHeader">
|
|
class documentation
|
|
</div>
|
|
|
|
<div class="extrasDocstring">
|
|
<p class="class-signature"><code><span class="py-keyword">class</span> <span class="py-defname">SweepSpacing</span>(<a href="https://docs.python.org/3/library/enum.html#enum.Enum" class="intersphinx-link">Enum</a>):</code></p>
|
|
<p><a href="classIndex.html#fn_gen.enums.sweep_spacing.SweepSpacing">View In Hierarchy</a></p>
|
|
</div>
|
|
|
|
<div class="moduleDocstring">
|
|
<div><p>The spacing used in the sweep function</p></div>
|
|
</div>
|
|
|
|
<div id="splitTables">
|
|
<table class="children sortable" id="id11">
|
|
|
|
|
|
<tr class="constant">
|
|
|
|
<td>Constant</td>
|
|
<td><code><a href="#LIN" class="internal-link" title="fn_gen.enums.sweep_spacing.SweepSpacing.LIN">LIN</a></code></td>
|
|
<td>A linear sweep</td>
|
|
</tr><tr class="constant">
|
|
|
|
<td>Constant</td>
|
|
<td><code><a href="#LOG" class="internal-link" title="fn_gen.enums.sweep_spacing.SweepSpacing.LOG">LOG</a></code></td>
|
|
<td>A logarithmic sweep</td>
|
|
</tr><tr class="constant">
|
|
|
|
<td>Constant</td>
|
|
<td><code><a href="#STEP" class="internal-link" title="fn_gen.enums.sweep_spacing.SweepSpacing.STEP">STEP</a></code></td>
|
|
<td>A stepwise sweep</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div id="childList">
|
|
<div class="baseconstant">
|
|
|
|
|
|
<a name="fn_gen.enums.sweep_spacing.SweepSpacing.LIN">
|
|
|
|
</a>
|
|
<a name="LIN">
|
|
|
|
</a>
|
|
<div class="functionHeader">
|
|
|
|
<span class="py-defname">LIN</span>: <code><a href="https://docs.python.org/3/library/functions.html#int" class="intersphinx-link">int</a></code> =
|
|
|
|
<a class="headerLink" href="#LIN" title="fn_gen.enums.sweep_spacing.SweepSpacing.LIN">
|
|
|
|
|
|
¶
|
|
</a>
|
|
</div>
|
|
<div class="functionBody">
|
|
|
|
<div><p>A linear sweep</p></div>
|
|
<table class="valueTable"><tr class="fieldStart"><td class="fieldName">Value</td></tr><tr><td><pre class="constant-value"><code>1</code></pre></td></tr></table>
|
|
</div>
|
|
</div><div class="baseconstant">
|
|
|
|
|
|
<a name="fn_gen.enums.sweep_spacing.SweepSpacing.LOG">
|
|
|
|
</a>
|
|
<a name="LOG">
|
|
|
|
</a>
|
|
<div class="functionHeader">
|
|
|
|
<span class="py-defname">LOG</span>: <code><a href="https://docs.python.org/3/library/functions.html#int" class="intersphinx-link">int</a></code> =
|
|
|
|
<a class="headerLink" href="#LOG" title="fn_gen.enums.sweep_spacing.SweepSpacing.LOG">
|
|
|
|
|
|
¶
|
|
</a>
|
|
</div>
|
|
<div class="functionBody">
|
|
|
|
<div><p>A logarithmic sweep</p></div>
|
|
<table class="valueTable"><tr class="fieldStart"><td class="fieldName">Value</td></tr><tr><td><pre class="constant-value"><code>2</code></pre></td></tr></table>
|
|
</div>
|
|
</div><div class="baseconstant">
|
|
|
|
|
|
<a name="fn_gen.enums.sweep_spacing.SweepSpacing.STEP">
|
|
|
|
</a>
|
|
<a name="STEP">
|
|
|
|
</a>
|
|
<div class="functionHeader">
|
|
|
|
<span class="py-defname">STEP</span>: <code><a href="https://docs.python.org/3/library/functions.html#int" class="intersphinx-link">int</a></code> =
|
|
|
|
<a class="headerLink" href="#STEP" title="fn_gen.enums.sweep_spacing.SweepSpacing.STEP">
|
|
|
|
|
|
¶
|
|
</a>
|
|
</div>
|
|
<div class="functionBody">
|
|
|
|
<div><p>A stepwise sweep</p></div>
|
|
<table class="valueTable"><tr class="fieldStart"><td class="fieldName">Value</td></tr><tr><td><pre class="constant-value"><code>3</code></pre></td></tr></table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<footer class="navbar navbar-default">
|
|
|
|
|
|
<div class="container">
|
|
<a href="index.html">API Documentation</a> for fn_gen,
|
|
generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
|
|
23.9.1 at 2024-02-29 14:55:42.
|
|
</div>
|
|
|
|
<!-- Search related scripts needs to be loaded at the end of HTML
|
|
parsing not to introduce overhead and display HTML data asap -->
|
|
<script src="ajax.js" type="text/javascript"></script>
|
|
<script src="searchlib.js" type="text/javascript"></script>
|
|
<script src="search.js" type="text/javascript"></script>
|
|
|
|
</footer>
|
|
|
|
<script src="pydoctor.js" type="text/javascript"></script>
|
|
|
|
</body>
|
|
</html> |