Skip to content

Commit 016799c

Browse files
ChadLin9596ChadLin9596
committed
deploy: cfd8072 
1 parent 960c1da commit 016799c

7 files changed

Lines changed: 159 additions & 4 deletions

File tree

‎api.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ <h1>API<a class="headerlink" href="#api" title="Permalink to this headline">¶</
4343
<col style="width: 90%" />
4444
</colgroup>
4545
<tbody>
46-
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">py_utils.utils_segmentation</span></code></p></td>
46+
<tr class="row-odd"><td><p><a class="reference internal" href="generated/py_utils.utils_segmentation.html#module-py_utils.utils_segmentation" title="py_utils.utils_segmentation"><code class="xref py py-obj docutils literal notranslate"><span class="pre">py_utils.utils_segmentation</span></code></a></p></td>
4747
<td><p></p></td>
4848
</tr>
4949
</tbody>

‎generated/py_utils.utils_segmentation.html‎

Lines changed: 44 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,50 @@ <h2 class="heading"><span>py_utils.utils_segmentation</span></h2>
3232
<div class="content" role="main">
3333

3434

35-
<div class="section" id="py-utils-utils-segmentation">
36-
<h1>py_utils.utils_segmentation<a class="headerlink" href="#py-utils-utils-segmentation" title="Permalink to this headline"></a></h1>
35+
<div class="section" id="module-py_utils.utils_segmentation">
36+
<span id="py-utils-utils-segmentation"></span><h1>py_utils.utils_segmentation<a class="headerlink" href="#module-py_utils.utils_segmentation" title="Permalink to this headline"></a></h1>
37+
<p class="rubric">Functions</p>
38+
<table class="longtable docutils align-default">
39+
<colgroup>
40+
<col style="width: 10%" />
41+
<col style="width: 90%" />
42+
</colgroup>
43+
<tbody>
44+
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">compute_sliding_window_indices</span></code>(N, window_size)</p></td>
45+
<td><p>Compute start and end indices for sliding windows over a sequence of length <cite>N</cite>.</p></td>
46+
</tr>
47+
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">compute_sliding_window_indices_with_overlap</span></code>(N, …)</p></td>
48+
<td><p></p></td>
49+
</tr>
50+
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">segmented_argmax</span></code>(x, s_ind, e_ind)</p></td>
51+
<td><p></p></td>
52+
</tr>
53+
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">segmented_argmin</span></code>(x, s_ind, e_ind)</p></td>
54+
<td><p></p></td>
55+
</tr>
56+
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">segmented_count</span></code>(x, s_ind, e_ind)</p></td>
57+
<td><p>Counts the number of elements along segments x[s_ind:e_ind]</p></td>
58+
</tr>
59+
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">segmented_max</span></code>(x, s_ind, e_ind[, return_indices])</p></td>
60+
<td><p>Computes the maximum along segments x[s_ind:e_ind, …] :returns:</p></td>
61+
</tr>
62+
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">segmented_mean</span></code>(x, s_ind, e_ind)</p></td>
63+
<td><p>Computes the average along segments x[s_ind:e_ind, …]</p></td>
64+
</tr>
65+
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">segmented_min</span></code>(x, s_ind, e_ind[, return_indices])</p></td>
66+
<td><p>Computes the minimum along segments x[s_ind:e_ind, …] :returns:</p></td>
67+
</tr>
68+
<tr class="row-odd"><td><p><a class="reference internal" href="../usage.html#py_utils.utils_segmentation.segmented_sum" title="py_utils.utils_segmentation.segmented_sum"><code class="xref py py-obj docutils literal notranslate"><span class="pre">segmented_sum</span></code></a>(x, s_ind, e_ind)</p></td>
69+
<td><p>Computes the summation along segments x[s_ind:e_ind, …]</p></td>
70+
</tr>
71+
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">segmented_where</span></code>(x, s_ind, e_ind, values)</p></td>
72+
<td><p>TODO: add docstring</p></td>
73+
</tr>
74+
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">sliding_window</span></code>(x[, window_size, same_size, …])</p></td>
75+
<td><p></p></td>
76+
</tr>
77+
</tbody>
78+
</table>
3779
</div>
3880

3981

‎genindex.html‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,8 @@ <h1 id="index">Index</h1>
3535

3636
<div class="genindex-jumpbox">
3737
<a href="#L"><strong>L</strong></a>
38+
| <a href="#P"><strong>P</strong></a>
39+
| <a href="#S"><strong>S</strong></a>
3840

3941
</div>
4042
<h2 id="L">L</h2>
@@ -45,6 +47,22 @@ <h2 id="L">L</h2>
4547
</ul></td>
4648
</tr></table>
4749

50+
<h2 id="P">P</h2>
51+
<table style="width: 100%" class="indextable genindextable"><tr>
52+
<td style="width: 33%; vertical-align: top;"><ul>
53+
<li><a href="generated/py_utils.utils_segmentation.html#module-py_utils.utils_segmentation">py_utils.utils_segmentation (module)</a>
54+
</li>
55+
</ul></td>
56+
</tr></table>
57+
58+
<h2 id="S">S</h2>
59+
<table style="width: 100%" class="indextable genindextable"><tr>
60+
<td style="width: 33%; vertical-align: top;"><ul>
61+
<li><a href="usage.html#py_utils.utils_segmentation.segmented_sum">segmented_sum() (in module py_utils.utils_segmentation)</a>
62+
</li>
63+
</ul></td>
64+
</tr></table>
65+
4866

4967

5068
</div>

‎objects.inv‎

28 Bytes
Binary file not shown.

‎py-modindex.html‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
2+
<!DOCTYPE html>
3+
4+
<html xmlns="http://www.w3.org/1999/xhtml">
5+
<head>
6+
<meta charset="utf-8" />
7+
<title>Python Module Index &#8212; py_utils 0.1.0 documentation</title>
8+
<link rel="stylesheet" href="_static/haiku.css" type="text/css" />
9+
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
10+
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
11+
<script src="_static/jquery.js"></script>
12+
<script src="_static/underscore.js"></script>
13+
<script src="_static/doctools.js"></script>
14+
<script src="_static/language_data.js"></script>
15+
<link rel="index" title="Index" href="genindex.html" />
16+
<link rel="search" title="Search" href="search.html" />
17+
18+
19+
20+
</head><body>
21+
<div class="header" role="banner"><h1 class="heading"><a href="index.html">
22+
<span>py_utils 0.1.0 documentation</span></a></h1>
23+
<h2 class="heading"><span>Python Module Index</span></h2>
24+
</div>
25+
<div class="topnav" role="navigation" aria-label="top navigation">
26+
27+
<p>
28+
<a class="uplink" href="index.html">Contents</a>
29+
</p>
30+
31+
</div>
32+
<div class="content" role="main">
33+
34+
35+
36+
<h1>Python Module Index</h1>
37+
38+
<div class="modindex-jumpbox">
39+
<a href="#cap-p"><strong>p</strong></a>
40+
</div>
41+
42+
<table class="indextable modindextable">
43+
<tr class="pcap"><td></td><td>&#160;</td><td></td></tr>
44+
<tr class="cap" id="cap-p"><td></td><td>
45+
<strong>p</strong></td><td></td></tr>
46+
<tr>
47+
<td><img src="_static/minus.png" class="toggler"
48+
id="toggle-1" style="display: none" alt="-" /></td>
49+
<td>
50+
<code class="xref">py_utils</code></td><td>
51+
<em></em></td></tr>
52+
<tr class="cg-1">
53+
<td></td>
54+
<td>&#160;&#160;&#160;
55+
<a href="generated/py_utils.utils_segmentation.html#module-py_utils.utils_segmentation"><code class="xref">py_utils.utils_segmentation</code></a></td><td>
56+
<em></em></td></tr>
57+
</table>
58+
59+
60+
</div>
61+
<div class="bottomnav" role="navigation" aria-label="bottom navigation">
62+
63+
<p>
64+
<a class="uplink" href="index.html">Contents</a>
65+
</p>
66+
67+
</div>
68+
69+
<div class="footer" role="contentinfo">
70+
&#169; Copyright 2025, Chad Lin.
71+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.4.4.
72+
</div>
73+
</body>
74+
</html>

‎searchindex.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎usage.html‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,27 @@ <h2>Creating recipes<a class="headerlink" href="#creating-recipes" title="Permal
7070
</dl>
7171
</dd></dl>
7272

73+
<dl class="function">
74+
<dt id="py_utils.utils_segmentation.segmented_sum">
75+
<code class="sig-prename descclassname">py_utils.utils_segmentation.</code><code class="sig-name descname">segmented_sum</code><span class="sig-paren">(</span><em class="sig-param">x</em>, <em class="sig-param">s_ind</em>, <em class="sig-param">e_ind</em><span class="sig-paren">)</span><a class="headerlink" href="#py_utils.utils_segmentation.segmented_sum" title="Permalink to this definition"></a></dt>
76+
<dd><p>Computes the summation along segments x[s_ind:e_ind, …]</p>
77+
<dl class="field-list simple">
78+
<dt class="field-odd">Parameters</dt>
79+
<dd class="field-odd"><ul class="simple">
80+
<li><p><strong>x</strong> (<em>a numpy ndarray</em>) – </p></li>
81+
<li><p><strong>s_ind</strong> (<em>a 1d array</em><em> (</em><em>n</em><em>,</em><em>)</em>) – </p></li>
82+
<li><p><strong>e_ind</strong> (<em>a 1d array</em><em> (</em><em>n</em><em>,</em><em>)</em>) – </p></li>
83+
</ul>
84+
</dd>
85+
<dt class="field-even">Returns</dt>
86+
<dd class="field-even"><p></p>
87+
</dd>
88+
<dt class="field-odd">Return type</dt>
89+
<dd class="field-odd"><p>a numpy ndarray</p>
90+
</dd>
91+
</dl>
92+
</dd></dl>
93+
7394
</div>
7495
</div>
7596

0 commit comments

Comments
 (0)