deploy: 259f31b

uber · Sep 27, 2024 · dcb4eac · dcb4eac
1 parent 24c496c
commit dcb4eac
Show file tree

Hide file tree

Showing 37 changed files with 195 additions and 26 deletions.
diff --git a/_changelog.html b/_changelog.html
@@ -442,12 +442,15 @@ <h2>Versioning<a class="headerlink" href="#versioning" title="Link to this headi
 </section>
 <section id="unreleased">
 <h2>Unreleased<a class="headerlink" href="#unreleased" title="Link to this heading">#</a></h2>
-<p>None.</p>
+<ul class="simple">
+<li><p>Add <code class="docutils literal notranslate"><span class="pre">cell_to_child_pos</span></code>, <code class="docutils literal notranslate"><span class="pre">child_pos_to_cell</span></code>, <code class="docutils literal notranslate"><span class="pre">cell_to_children_size</span></code> (#405)</p></li>
+</ul>
 </section>
 <section id="b1-2024-09-26">
 <h2>[4.1.0b1] - 2024-09-26<a class="headerlink" href="#b1-2024-09-26" title="Link to this heading">#</a></h2>
 <ul class="simple">
 <li><p>Bump h3lib to v4.1.0 (#402)</p></li>
+<li><p>Add <code class="docutils literal notranslate"><span class="pre">polygon_to_cells</span></code> alias (#399)</p></li>
 </ul>
 </section>
 <section id="b7-2024-09-04">
@@ -459,7 +462,7 @@ <h2>[4.0.0b7] - 2024-09-04<a class="headerlink" href="#b7-2024-09-04" title="Lin
 <section id="b6-2024-09-03">
 <h2>[4.0.0b6] - 2024-09-03<a class="headerlink" href="#b6-2024-09-03" title="Link to this heading">#</a></h2>
 <ul class="simple">
-<li><p>Added bindings for <code class="docutils literal notranslate"><span class="pre">cellToVertex</span></code>, <code class="docutils literal notranslate"><span class="pre">cellToVertexes</span></code>, <code class="docutils literal notranslate"><span class="pre">vertexToLatLng</span></code>, and <code class="docutils literal notranslate"><span class="pre">isValidVertex</span></code> (#323)</p></li>
+<li><p>Added bindings for <code class="docutils literal notranslate"><span class="pre">cellToVertex</span></code>, <code class="docutils literal notranslate"><span class="pre">cellToVertexes</span></code>, <code class="docutils literal notranslate"><span class="pre">vertexToLatLng</span></code>, and <code class="docutils literal notranslate"><span class="pre">isValidVertex</span></code> (#388)</p></li>
 </ul>
 </section>
 <section id="b5-2024-05-19">

diff --git a/_images/15e50c1a4269b2e3702e244ed830eb6cb00f215e40b7e24262b04cae944ea5ce.png b/_images/15e50c1a4269b2e3702e244ed830eb6cb00f215e40b7e24262b04cae944ea5ce.png
diff --git a/_images/1ae95ae28b16bc06dd521e2688befdec2056dd9e2719b871aef372130b8c0996.png b/_images/1ae95ae28b16bc06dd521e2688befdec2056dd9e2719b871aef372130b8c0996.png
diff --git a/_images/1c00cdf2e8e19f94ea2080128c317122acce5f30cd8a8612ef53475db633d01b.png b/_images/1c00cdf2e8e19f94ea2080128c317122acce5f30cd8a8612ef53475db633d01b.png
diff --git a/_images/1e559b985084f759342792359903722e21ac515926003b556416c5a6a4812260.png b/_images/1e559b985084f759342792359903722e21ac515926003b556416c5a6a4812260.png
diff --git a/_images/2008ed0a62a5c7ab379672977891e0084df73d64c377c9df7d458896c5e1f0f7.png b/_images/2008ed0a62a5c7ab379672977891e0084df73d64c377c9df7d458896c5e1f0f7.png
diff --git a/_images/2a036a34c38c74785f225426477e78855cf4183aede6baac5a72178974f168c2.png b/_images/2a036a34c38c74785f225426477e78855cf4183aede6baac5a72178974f168c2.png
diff --git a/_images/2c3887a94993f170733bc8b2310c26c5950a983e06e91e248781c25a7a167b34.png b/_images/2c3887a94993f170733bc8b2310c26c5950a983e06e91e248781c25a7a167b34.png
diff --git a/_images/35bd65260d030471566511f1c6fc412a738e49d1b2b11df05156fbb46b183fee.png b/_images/35bd65260d030471566511f1c6fc412a738e49d1b2b11df05156fbb46b183fee.png
diff --git a/_images/43e58c28792c728ec5b006c4807a208a8d3f7293bdcde14efa26ad6e2f151d32.png b/_images/43e58c28792c728ec5b006c4807a208a8d3f7293bdcde14efa26ad6e2f151d32.png
diff --git a/_images/504815f2fcacce596d0b329aad0978c0f8fc0f342aaf874636ab312e3f08b9d4.png b/_images/504815f2fcacce596d0b329aad0978c0f8fc0f342aaf874636ab312e3f08b9d4.png
diff --git a/_images/528b194eaff016e3360df5dcdfce755589584add430a3eca75c6648412ee918b.png b/_images/528b194eaff016e3360df5dcdfce755589584add430a3eca75c6648412ee918b.png
diff --git a/_images/52ed5932af61c66906d4fe0f9ceb8a1262e0b7e824044b366b83639cb9fa3147.png b/_images/52ed5932af61c66906d4fe0f9ceb8a1262e0b7e824044b366b83639cb9fa3147.png
diff --git a/_images/5b2cb731b3249333f13e3d2424437af8985f0fe7650d8e9e1bf716589b7a9b73.png b/_images/5b2cb731b3249333f13e3d2424437af8985f0fe7650d8e9e1bf716589b7a9b73.png
diff --git a/_images/5dc5e2e0d04416230d5e1fbe413e6181661ac7ca50c31527352da674f9e3cdbf.png b/_images/5dc5e2e0d04416230d5e1fbe413e6181661ac7ca50c31527352da674f9e3cdbf.png
diff --git a/_images/61f9277e4b275a2baf3366fb9b7ffd4dc6b976e0cf3500cad3995542c366c571.png b/_images/61f9277e4b275a2baf3366fb9b7ffd4dc6b976e0cf3500cad3995542c366c571.png
diff --git a/_images/6be29af43b6da3132df3a20cb69dee145866ef2cec9db37f453b1ad46e3b1cef.png b/_images/6be29af43b6da3132df3a20cb69dee145866ef2cec9db37f453b1ad46e3b1cef.png
diff --git a/_images/6d5aa5162a73af5397a7333b81a20f8d7c6199547dde1407b3a3082bfe39e0e8.png b/_images/6d5aa5162a73af5397a7333b81a20f8d7c6199547dde1407b3a3082bfe39e0e8.png
diff --git a/_images/7ea4b1273b1632166e79c91d161de69c050f6adc9888121860a547aa16256bdd.png b/_images/7ea4b1273b1632166e79c91d161de69c050f6adc9888121860a547aa16256bdd.png
diff --git a/_images/83fd71055f95fb630416725bef287969bb1659b65689fa5b9ef0ba0a3ddf5819.png b/_images/83fd71055f95fb630416725bef287969bb1659b65689fa5b9ef0ba0a3ddf5819.png
diff --git a/_images/8b9ba124ce3703e5fdf7728c39edd214e36248cb9bb863f721d01db1b9b74589.png b/_images/8b9ba124ce3703e5fdf7728c39edd214e36248cb9bb863f721d01db1b9b74589.png
diff --git a/_images/92317db4d10b48b65ee89059a0d929eb5a793672133d030e8d82ace14314e7f3.png b/_images/92317db4d10b48b65ee89059a0d929eb5a793672133d030e8d82ace14314e7f3.png
diff --git a/_images/94be370d18d02e7188ace01ee9579e95e3e23f05d56de010d9e11897abd58f13.png b/_images/94be370d18d02e7188ace01ee9579e95e3e23f05d56de010d9e11897abd58f13.png
diff --git a/_images/a347b4df14d1eba366f32a2fc30c9d877528ae1a88088c16617ed11c3131e173.png b/_images/a347b4df14d1eba366f32a2fc30c9d877528ae1a88088c16617ed11c3131e173.png
diff --git a/_images/afbafece4f7bef95a940d1839552be5e841bd9ef2ee1d08f792c30d4a2448887.png b/_images/afbafece4f7bef95a940d1839552be5e841bd9ef2ee1d08f792c30d4a2448887.png
diff --git a/_images/b2b7c0f19619b98f13607633cc98e0070ac1a815ba269c65dbe52e252bb1ada6.png b/_images/b2b7c0f19619b98f13607633cc98e0070ac1a815ba269c65dbe52e252bb1ada6.png
diff --git a/_images/d38896b40de8caca29c35c9e041094be840f1cc34ce7bfdb90fc02e107934480.png b/_images/d38896b40de8caca29c35c9e041094be840f1cc34ce7bfdb90fc02e107934480.png
diff --git a/_images/dfae9794685824c5379c91b8d55319cb72578383202e515c7dc22869e6580eef.png b/_images/dfae9794685824c5379c91b8d55319cb72578383202e515c7dc22869e6580eef.png
diff --git a/_images/fb1583413a43768822ddef2586ae5644deb7c630d2e02aa8b070d28c86ecc0cd.png b/_images/fb1583413a43768822ddef2586ae5644deb7c630d2e02aa8b070d28c86ecc0cd.png
diff --git a/_modules/h3/api/basic_str.html b/_modules/h3/api/basic_str.html
@@ -523,7 +523,8 @@ <h1>Source code for h3.api.basic_str</h1><div class="highlight"><pre>
 <span class="sd">    lng : float</span>
 <span class="sd">        Longitude</span>
 <span class="sd">    &quot;&quot;&quot;</span>
-    <span class="k">return</span> <span class="n">_cy</span><span class="o">.</span><span class="n">cell_to_latlng</span><span class="p">(</span><span class="n">_in_scalar</span><span class="p">(</span><span class="n">h</span><span class="p">))</span></div>
+    <span class="n">h</span> <span class="o">=</span> <span class="n">_in_scalar</span><span class="p">(</span><span class="n">h</span><span class="p">)</span>
+    <span class="k">return</span> <span class="n">_cy</span><span class="o">.</span><span class="n">cell_to_latlng</span><span class="p">(</span><span class="n">h</span><span class="p">)</span></div>
 
 
 
@@ -542,7 +543,8 @@ <h1>Source code for h3.api.basic_str</h1><div class="highlight"><pre>
 <span class="sd">    int</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="c1"># todo: could also work for edges</span>
-    <span class="k">return</span> <span class="n">_cy</span><span class="o">.</span><span class="n">get_resolution</span><span class="p">(</span><span class="n">_in_scalar</span><span class="p">(</span><span class="n">h</span><span class="p">))</span></div>
+    <span class="n">h</span> <span class="o">=</span> <span class="n">_in_scalar</span><span class="p">(</span><span class="n">h</span><span class="p">)</span>
+    <span class="k">return</span> <span class="n">_cy</span><span class="o">.</span><span class="n">get_resolution</span><span class="p">(</span><span class="n">h</span><span class="p">)</span></div>
 
 
 
@@ -616,7 +618,8 @@ <h1>Source code for h3.api.basic_str</h1><div class="highlight"><pre>
 <span class="sd">    -------</span>
 <span class="sd">    tuple of (lat, lng) tuples</span>
 <span class="sd">    &quot;&quot;&quot;</span>
-    <span class="k">return</span> <span class="n">_cy</span><span class="o">.</span><span class="n">cell_to_boundary</span><span class="p">(</span><span class="n">_in_scalar</span><span class="p">(</span><span class="n">h</span><span class="p">))</span></div>
+    <span class="n">h</span> <span class="o">=</span> <span class="n">_in_scalar</span><span class="p">(</span><span class="n">h</span><span class="p">)</span>
+    <span class="k">return</span> <span class="n">_cy</span><span class="o">.</span><span class="n">cell_to_boundary</span><span class="p">(</span><span class="n">h</span><span class="p">)</span></div>
 
 
 
@@ -641,7 +644,8 @@ <h1>Source code for h3.api.basic_str</h1><div class="highlight"><pre>
 <span class="sd">    -----</span>
 <span class="sd">    There is currently no guaranteed order of the output cells.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
-    <span class="n">mv</span> <span class="o">=</span> <span class="n">_cy</span><span class="o">.</span><span class="n">grid_disk</span><span class="p">(</span><span class="n">_in_scalar</span><span class="p">(</span><span class="n">h</span><span class="p">),</span> <span class="n">k</span><span class="p">)</span>
+    <span class="n">h</span> <span class="o">=</span> <span class="n">_in_scalar</span><span class="p">(</span><span class="n">h</span><span class="p">)</span>
+    <span class="n">mv</span> <span class="o">=</span> <span class="n">_cy</span><span class="o">.</span><span class="n">grid_disk</span><span class="p">(</span><span class="n">h</span><span class="p">,</span> <span class="n">k</span><span class="p">)</span>
 
     <span class="k">return</span> <span class="n">_out_collection</span><span class="p">(</span><span class="n">mv</span><span class="p">)</span></div>
 
@@ -668,12 +672,36 @@ <h1>Source code for h3.api.basic_str</h1><div class="highlight"><pre>
 <span class="sd">    -----</span>
 <span class="sd">    There is currently no guaranteed order of the output cells.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
-    <span class="n">mv</span> <span class="o">=</span> <span class="n">_cy</span><span class="o">.</span><span class="n">grid_ring</span><span class="p">(</span><span class="n">_in_scalar</span><span class="p">(</span><span class="n">h</span><span class="p">),</span> <span class="n">k</span><span class="p">)</span>
+    <span class="n">h</span> <span class="o">=</span> <span class="n">_in_scalar</span><span class="p">(</span><span class="n">h</span><span class="p">)</span>
+    <span class="n">mv</span> <span class="o">=</span> <span class="n">_cy</span><span class="o">.</span><span class="n">grid_ring</span><span class="p">(</span><span class="n">h</span><span class="p">,</span> <span class="n">k</span><span class="p">)</span>
 
     <span class="k">return</span> <span class="n">_out_collection</span><span class="p">(</span><span class="n">mv</span><span class="p">)</span></div>
 
 
 
+<div class="viewcode-block" id="cell_to_children_size">
+<a class="viewcode-back" href="../../../api_verbose.html#h3.cell_to_children_size">[docs]</a>
+<span class="k">def</span> <span class="nf">cell_to_children_size</span><span class="p">(</span><span class="n">h</span><span class="p">,</span> <span class="n">res</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">    Number of children at resolution ``res`` of given cell.</span>
+
+<span class="sd">    Parameters</span>
+<span class="sd">    ----------</span>
+<span class="sd">    h : H3Cell</span>
+<span class="sd">    res : int or None, optional</span>
+<span class="sd">        The resolution for the children.</span>
+<span class="sd">        If ``None``, then ``res = resolution(h) + 1``</span>
+
+<span class="sd">    Returns</span>
+<span class="sd">    -------</span>
+<span class="sd">    int</span>
+<span class="sd">        Count of children</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+    <span class="n">h</span> <span class="o">=</span> <span class="n">_in_scalar</span><span class="p">(</span><span class="n">h</span><span class="p">)</span>
+    <span class="k">return</span> <span class="n">_cy</span><span class="o">.</span><span class="n">cell_to_children_size</span><span class="p">(</span><span class="n">h</span><span class="p">,</span> <span class="n">res</span><span class="p">)</span></div>
+
+
+
 <div class="viewcode-block" id="cell_to_children">
 <a class="viewcode-back" href="../../../api_verbose.html#h3.cell_to_children">[docs]</a>
 <span class="k">def</span> <span class="nf">cell_to_children</span><span class="p">(</span><span class="n">h</span><span class="p">,</span> <span class="n">res</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
@@ -695,12 +723,65 @@ <h1>Source code for h3.api.basic_str</h1><div class="highlight"><pre>
 <span class="sd">    -----</span>
 <span class="sd">    There is currently no guaranteed order of the output cells.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
-    <span class="n">mv</span> <span class="o">=</span> <span class="n">_cy</span><span class="o">.</span><span class="n">cell_to_children</span><span class="p">(</span><span class="n">_in_scalar</span><span class="p">(</span><span class="n">h</span><span class="p">),</span> <span class="n">res</span><span class="p">)</span>
+    <span class="n">h</span> <span class="o">=</span> <span class="n">_in_scalar</span><span class="p">(</span><span class="n">h</span><span class="p">)</span>
+    <span class="n">mv</span> <span class="o">=</span> <span class="n">_cy</span><span class="o">.</span><span class="n">cell_to_children</span><span class="p">(</span><span class="n">h</span><span class="p">,</span> <span class="n">res</span><span class="p">)</span>
 
     <span class="k">return</span> <span class="n">_out_collection</span><span class="p">(</span><span class="n">mv</span><span class="p">)</span></div>
 
 
 
+<div class="viewcode-block" id="cell_to_child_pos">
+<a class="viewcode-back" href="../../../api_verbose.html#h3.cell_to_child_pos">[docs]</a>
+<span class="k">def</span> <span class="nf">cell_to_child_pos</span><span class="p">(</span><span class="n">child</span><span class="p">,</span> <span class="n">res_parent</span><span class="p">):</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">    Child position index of given cell, with respect to its parent at ``res_parent``.</span>
+
+<span class="sd">    The reverse operation can be done with ``child_pos_to_cell``.</span>
+
+<span class="sd">    Parameters</span>
+<span class="sd">    ----------</span>
+<span class="sd">    child : H3Cell</span>
+<span class="sd">    res_parent : int</span>
+
+<span class="sd">    Returns</span>
+<span class="sd">    -------</span>
+<span class="sd">    int</span>
+<span class="sd">        Integer index of the child with respect to parent cell.</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+    <span class="n">child</span> <span class="o">=</span> <span class="n">_in_scalar</span><span class="p">(</span><span class="n">child</span><span class="p">)</span>
+    <span class="k">return</span> <span class="n">_cy</span><span class="o">.</span><span class="n">cell_to_child_pos</span><span class="p">(</span><span class="n">child</span><span class="p">,</span> <span class="n">res_parent</span><span class="p">)</span></div>
+
+
+
+<div class="viewcode-block" id="child_pos_to_cell">
+<a class="viewcode-back" href="../../../api_verbose.html#h3.child_pos_to_cell">[docs]</a>
+<span class="k">def</span> <span class="nf">child_pos_to_cell</span><span class="p">(</span><span class="n">parent</span><span class="p">,</span> <span class="n">res_child</span><span class="p">,</span> <span class="n">child_pos</span><span class="p">):</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">    Get child H3 cell from a parent cell, child resolution, and child position index.</span>
+
+<span class="sd">    The reverse operation can be done with ``cell_to_child_pos``.</span>
+
+<span class="sd">    Parameters</span>
+<span class="sd">    ----------</span>
+<span class="sd">    parent : H3Cell</span>
+<span class="sd">    res_child : int</span>
+<span class="sd">        Child cell resolution</span>
+<span class="sd">    child_pos : int</span>
+<span class="sd">        Integer position of child cell, releative to parent.</span>
+
+
+<span class="sd">    Returns</span>
+<span class="sd">    -------</span>
+<span class="sd">    H3Cell</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+    <span class="n">parent</span> <span class="o">=</span> <span class="n">_in_scalar</span><span class="p">(</span><span class="n">parent</span><span class="p">)</span>
+    <span class="n">child</span> <span class="o">=</span> <span class="n">_cy</span><span class="o">.</span><span class="n">child_pos_to_cell</span><span class="p">(</span><span class="n">parent</span><span class="p">,</span> <span class="n">res_child</span><span class="p">,</span> <span class="n">child_pos</span><span class="p">)</span>
+    <span class="n">child</span> <span class="o">=</span> <span class="n">_out_scalar</span><span class="p">(</span><span class="n">child</span><span class="p">)</span>
+
+    <span class="k">return</span> <span class="n">child</span></div>
+
+
+
 <span class="c1"># todo: nogil for expensive C operation?</span>
 <div class="viewcode-block" id="compact_cells">
 <a class="viewcode-back" href="../../../api_verbose.html#h3.compact_cells">[docs]</a>

diff --git a/_sources/api_quick.md b/_sources/api_quick.md
@@ -79,6 +79,9 @@ Functions relating H3 objects to geographic (lat/lng) coordinates.
    cell_to_parent
    cell_to_children
    cell_to_center_child
+   cell_to_children_size
+   cell_to_child_pos
+   child_pos_to_cell
    compact_cells
    uncompact_cells
 ```

diff --git a/api_quick.html b/api_quick.html
@@ -537,10 +537,19 @@ <h2>Hierarchical relationships<a class="headerlink" href="#hierarchical-relation
 <tr class="row-odd"><td><p><a class="reference internal" href="api_verbose.html#h3.cell_to_center_child" title="h3.cell_to_center_child"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cell_to_center_child</span></code></a>(h[, res])</p></td>
 <td><p>Get the center child of a cell at some finer resolution.</p></td>
 </tr>
-<tr class="row-even"><td><p><a class="reference internal" href="api_verbose.html#h3.compact_cells" title="h3.compact_cells"><code class="xref py py-obj docutils literal notranslate"><span class="pre">compact_cells</span></code></a>(cells)</p></td>
+<tr class="row-even"><td><p><a class="reference internal" href="api_verbose.html#h3.cell_to_children_size" title="h3.cell_to_children_size"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cell_to_children_size</span></code></a>(h[, res])</p></td>
+<td><p>Number of children at resolution <code class="docutils literal notranslate"><span class="pre">res</span></code> of given cell.</p></td>
+</tr>
+<tr class="row-odd"><td><p><a class="reference internal" href="api_verbose.html#h3.cell_to_child_pos" title="h3.cell_to_child_pos"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cell_to_child_pos</span></code></a>(child, res_parent)</p></td>
+<td><p>Child position index of given cell, with respect to its parent at <code class="docutils literal notranslate"><span class="pre">res_parent</span></code>.</p></td>
+</tr>
+<tr class="row-even"><td><p><a class="reference internal" href="api_verbose.html#h3.child_pos_to_cell" title="h3.child_pos_to_cell"><code class="xref py py-obj docutils literal notranslate"><span class="pre">child_pos_to_cell</span></code></a>(parent, res_child, child_pos)</p></td>
+<td><p>Get child H3 cell from a parent cell, child resolution, and child position index.</p></td>
+</tr>
+<tr class="row-odd"><td><p><a class="reference internal" href="api_verbose.html#h3.compact_cells" title="h3.compact_cells"><code class="xref py py-obj docutils literal notranslate"><span class="pre">compact_cells</span></code></a>(cells)</p></td>
 <td><p>Compact a collection of H3 cells by combining smaller cells into larger cells, if all child cells are present.</p></td>
 </tr>
-<tr class="row-odd"><td><p><a class="reference internal" href="api_verbose.html#h3.uncompact_cells" title="h3.uncompact_cells"><code class="xref py py-obj docutils literal notranslate"><span class="pre">uncompact_cells</span></code></a>(cells, res)</p></td>
+<tr class="row-even"><td><p><a class="reference internal" href="api_verbose.html#h3.uncompact_cells" title="h3.uncompact_cells"><code class="xref py py-obj docutils literal notranslate"><span class="pre">uncompact_cells</span></code></a>(cells, res)</p></td>
 <td><p>Reverse the <code class="docutils literal notranslate"><span class="pre">compact_cells</span></code> operation.</p></td>
 </tr>
 </tbody>