mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-05-24 17:00:37 +00:00
2 lines
13 KiB
HTML
2 lines
13 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `h3` mod in crate `common_function`."><title>common_function::scalars::geo::h3 - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../static.files/rustdoc-17e0aaed.css"><meta name="rustdoc-vars" data-root-path="../../../../" data-static-root-path="../../../../static.files/" data-current-crate="common_function" data-themes="" data-resource-suffix="" data-rustdoc-version="1.96.0-nightly (ac7f9ec7d 2026-03-20)" data-channel="nightly" data-search-js="search-63369b7b.js" data-stringdex-js="stringdex-2da4960a.js" data-settings-js="settings-170eb4bf.js" ><script src="../../../../static.files/storage-41dd4d93.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../../../static.files/main-5013f961.js"></script><noscript><link rel="stylesheet" href="../../../../static.files/noscript-f7c3ffd8.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><a class="skip-main-content" href="#main-content">Skip to main content</a><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">Module h3</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../../common_function/index.html">common_<wbr>function</a><span class="version">1.0.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module h3</a></h2><h3><a href="#macros">Module Items</a></h3><ul class="block"><li><a href="#macros" title="Macros">Macros</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#statics" title="Statics">Statics</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In common_<wbr>function::<wbr>scalars::<wbr>geo</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content" tabindex="-1"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../../../index.html">common_function</a>::<wbr><a href="../../index.html">scalars</a>::<wbr><a href="../index.html">geo</a></div><h1>Module <span>h3</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../../../src/common_function/scalars/geo/h3.rs.html#15-1490">Source</a> </span></div><h2 id="macros" class="section-header">Macros<a href="#macros" class="anchor">§</a></h2><dl class="item-table"><dt><a class="macro" href="macro.ensure_then_coerce.html" title="macro common_function::scalars::geo::h3::ensure_then_coerce">ensure_<wbr>then_<wbr>coerce</a><span title="Restricted Visibility"> 🔒</span> </dt></dl><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.H3CellBase.html" title="struct common_function::scalars::geo::h3::H3CellBase">H3Cell<wbr>Base</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Function that returns base cell of given cell id</dd><dt><a class="struct" href="struct.H3CellCenterChild.html" title="struct common_function::scalars::geo::h3::H3CellCenterChild">H3Cell<wbr>Center<wbr>Child</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Function that returns center child cell of given cell id</dd><dt><a class="struct" href="struct.H3CellCenterLatLng.html" title="struct common_function::scalars::geo::h3::H3CellCenterLatLng">H3Cell<wbr>Center<wbr>LatLng</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Function that returns centroid latitude and longitude of given cell id</dd><dt><a class="struct" href="struct.H3CellContains.html" title="struct common_function::scalars::geo::h3::H3CellContains">H3Cell<wbr>Contains</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Tests if cells contains given cells</dd><dt><a class="struct" href="struct.H3CellDistanceEuclideanDegree.html" title="struct common_function::scalars::geo::h3::H3CellDistanceEuclideanDegree">H3Cell<wbr>Distance<wbr>Euclidean<wbr>Degree</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Get Euclidean distance of two cell centroid</dd><dt><a class="struct" href="struct.H3CellDistanceSphereKm.html" title="struct common_function::scalars::geo::h3::H3CellDistanceSphereKm">H3Cell<wbr>Distance<wbr>Sphere<wbr>Km</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Get WGS84 great circle distance of two cell centroid</dd><dt><a class="struct" href="struct.H3CellIsPentagon.html" title="struct common_function::scalars::geo::h3::H3CellIsPentagon">H3Cell<wbr>IsPentagon</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Function that check if given cell id is a pentagon</dd><dt><a class="struct" href="struct.H3CellParent.html" title="struct common_function::scalars::geo::h3::H3CellParent">H3Cell<wbr>Parent</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Function that returns parent cell of given cell id and resolution</dd><dt><a class="struct" href="struct.H3CellResolution.html" title="struct common_function::scalars::geo::h3::H3CellResolution">H3Cell<wbr>Resolution</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Function that returns resolution of given cell id</dd><dt><a class="struct" href="struct.H3CellToChildPos.html" title="struct common_function::scalars::geo::h3::H3CellToChildPos">H3Cell<wbr>ToChild<wbr>Pos</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Function that returns the cell position if its parent at given resolution</dd><dt><a class="struct" href="struct.H3CellToChildren.html" title="struct common_function::scalars::geo::h3::H3CellToChildren">H3Cell<wbr>ToChildren</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Function that returns children cell list</dd><dt><a class="struct" href="struct.H3CellToChildrenSize.html" title="struct common_function::scalars::geo::h3::H3CellToChildrenSize">H3Cell<wbr>ToChildren<wbr>Size</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Function that returns children cell count</dd><dt><a class="struct" href="struct.H3CellToString.html" title="struct common_function::scalars::geo::h3::H3CellToString">H3Cell<wbr>ToString</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Function that converts cell id to its string form</dd><dt><a class="struct" href="struct.H3ChildPosToCell.html" title="struct common_function::scalars::geo::h3::H3ChildPosToCell">H3Child<wbr>PosTo<wbr>Cell</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Function that returns the cell at given position of the parent at given resolution</dd><dt><a class="struct" href="struct.H3GridDisk.html" title="struct common_function::scalars::geo::h3::H3GridDisk">H3Grid<wbr>Disk</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Function that returns cells with k distances of given cell</dd><dt><a class="struct" href="struct.H3GridDiskDistances.html" title="struct common_function::scalars::geo::h3::H3GridDiskDistances">H3Grid<wbr>Disk<wbr>Distances</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Function that returns all cells within k distances of given cell</dd><dt><a class="struct" href="struct.H3GridDistance.html" title="struct common_function::scalars::geo::h3::H3GridDistance">H3Grid<wbr>Distance</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Function that returns distance between two cells</dd><dt><a class="struct" href="struct.H3GridPathCells.html" title="struct common_function::scalars::geo::h3::H3GridPathCells">H3Grid<wbr>Path<wbr>Cells</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Function that returns path cells between two cells</dd><dt><a class="struct" href="struct.H3LatLngToCell.html" title="struct common_function::scalars::geo::h3::H3LatLngToCell">H3Lat<wbr>LngTo<wbr>Cell</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Function that returns <a href="https://h3geo.org/">h3</a> encoding cellid for a given geospatial coordinate.</dd><dt><a class="struct" href="struct.H3LatLngToCellString.html" title="struct common_function::scalars::geo::h3::H3LatLngToCellString">H3Lat<wbr>LngTo<wbr>Cell<wbr>String</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Function that returns <a href="https://h3geo.org/">h3</a> encoding cellid in string form for a given
|
|
geospatial coordinate.</dd><dt><a class="struct" href="struct.H3StringToCell.html" title="struct common_function::scalars::geo::h3::H3StringToCell">H3String<wbr>ToCell</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Function that converts cell string id to uint64 number</dd></dl><h2 id="statics" class="section-header">Statics<a href="#statics" class="anchor">§</a></h2><dl class="item-table"><dt><a class="static" href="static.CELL_TYPES.html" title="static common_function::scalars::geo::h3::CELL_TYPES">CELL_<wbr>TYPES</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="static" href="static.COORDINATE_TYPES.html" title="static common_function::scalars::geo::h3::COORDINATE_TYPES">COORDINATE_<wbr>TYPES</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="static" href="static.DISTANCE_TYPES.html" title="static common_function::scalars::geo::h3::DISTANCE_TYPES">DISTANCE_<wbr>TYPES</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="static" href="static.POSITION_TYPES.html" title="static common_function::scalars::geo::h3::POSITION_TYPES">POSITION_<wbr>TYPES</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="static" href="static.RESOLUTION_TYPES.html" title="static common_function::scalars::geo::h3::RESOLUTION_TYPES">RESOLUTION_<wbr>TYPES</a><span title="Restricted Visibility"> 🔒</span> </dt></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.calculate_cell_child_property.html" title="fn common_function::scalars::geo::h3::calculate_cell_child_property">calculate_<wbr>cell_<wbr>child_<wbr>property</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.cell_from_value.html" title="fn common_function::scalars::geo::h3::cell_from_value">cell_<wbr>from_<wbr>value</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.cells_from_value.html" title="fn common_function::scalars::geo::h3::cells_from_value">cells_<wbr>from_<wbr>value</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>extract cell array from all possible types including:</dd><dt><a class="fn" href="fn.signature_of_cell.html" title="fn common_function::scalars::geo::h3::signature_of_cell">signature_<wbr>of_<wbr>cell</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.signature_of_cell_and_distance.html" title="fn common_function::scalars::geo::h3::signature_of_cell_and_distance">signature_<wbr>of_<wbr>cell_<wbr>and_<wbr>distance</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.signature_of_cell_and_resolution.html" title="fn common_function::scalars::geo::h3::signature_of_cell_and_resolution">signature_<wbr>of_<wbr>cell_<wbr>and_<wbr>resolution</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.signature_of_double_cells.html" title="fn common_function::scalars::geo::h3::signature_of_double_cells">signature_<wbr>of_<wbr>double_<wbr>cells</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.value_to_distance.html" title="fn common_function::scalars::geo::h3::value_to_distance">value_<wbr>to_<wbr>distance</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.value_to_position.html" title="fn common_function::scalars::geo::h3::value_to_position">value_<wbr>to_<wbr>position</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.value_to_resolution.html" title="fn common_function::scalars::geo::h3::value_to_resolution">value_<wbr>to_<wbr>resolution</a><span title="Restricted Visibility"> 🔒</span> </dt></dl></section></div></main></body></html> |