mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2025-12-22 22:20:02 +00:00
30 lines
6.2 KiB
HTML
30 lines
6.2 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="Allies a binary infallable function to two `PrimitiveArray`s, producing a new `PrimitiveArray`"><title>binary in datatypes::compute - 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-e56847b5.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="datatypes" data-themes="" data-resource-suffix="" data-rustdoc-version="1.92.0-nightly (fa3155a64 2025-09-30)" data-channel="nightly" data-search-js="search-e256b49e.js" data-stringdex-js="stringdex-828709d0.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-ce535bd0.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.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 fn"><!--[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="#">binary</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../datatypes/index.html">datatypes</a><span class="version">1.0.0-beta.3</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">binary</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#details" title="Details">Details</a></li><li><a href="#errors" title="Errors">Errors</a></li><li><a href="#example" title="Example">Example</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In datatypes::<wbr>compute</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"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">datatypes</a>::<wbr><a href="index.html">compute</a></div><h1>Function <span class="fn">binary</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"></span></div><pre class="rust item-decl"><code>pub fn binary<A, B, F, O>(
|
|
a: &PrimitiveArray<A>,
|
|
b: &PrimitiveArray<B>,
|
|
op: F,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><PrimitiveArray<O>, ArrowError><div class="where">where
|
|
A: ArrowPrimitiveType,
|
|
B: ArrowPrimitiveType,
|
|
O: ArrowPrimitiveType,
|
|
F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(<A as ArrowPrimitiveType>::Native, <B as ArrowPrimitiveType>::Native) -> <O as ArrowPrimitiveType>::Native,</div></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Allies a binary infallable function to two [<code>PrimitiveArray</code>]s,
|
|
producing a new [<code>PrimitiveArray</code>]</p>
|
|
<h2 id="details"><a class="doc-anchor" href="#details">§</a>Details</h2>
|
|
<p>Given two arrays of length <code>len</code>, calls <code>op(a[i], b[i])</code> for <code>i</code> in <code>0..len</code>, collecting
|
|
the results in a [<code>PrimitiveArray</code>].</p>
|
|
<p>If any index is null in either <code>a</code> or <code>b</code>, the
|
|
corresponding index in the result will also be null</p>
|
|
<p>Like <a href="fn.unary.html" title="fn datatypes::compute::unary"><code>unary</code></a>, the <code>op</code> is evaluated for every element in the two arrays,
|
|
including those elements which are NULL. This is beneficial as the cost of
|
|
the operation is low compared to the cost of branching, and especially when
|
|
the operation can be vectorised, however, requires <code>op</code> to be infallible for
|
|
all possible values of its inputs</p>
|
|
<h2 id="errors"><a class="doc-anchor" href="#errors">§</a>Errors</h2>
|
|
<ul>
|
|
<li>if the arrays have different lengths.</li>
|
|
</ul>
|
|
<h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</h2>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>a = Float32Array::from(<span class="macro">vec!</span>[<span class="prelude-val">Some</span>(<span class="number">5.1f32</span>), <span class="prelude-val">None</span>, <span class="prelude-val">Some</span>(<span class="number">6.8</span>), <span class="prelude-val">Some</span>(<span class="number">7.2</span>)]);
|
|
<span class="kw">let </span>b = Int32Array::from(<span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">4</span>, <span class="number">9</span>]);
|
|
<span class="comment">// compute int(a) + b for each element
|
|
</span><span class="kw">let </span>c = binary(<span class="kw-2">&</span>a, <span class="kw-2">&</span>b, |a, b| a <span class="kw">as </span>i32 + b).unwrap();
|
|
<span class="macro">assert_eq!</span>(c, Int32Array::from(<span class="macro">vec!</span>[<span class="prelude-val">Some</span>(<span class="number">6</span>), <span class="prelude-val">None</span>, <span class="prelude-val">Some</span>(<span class="number">10</span>), <span class="prelude-val">Some</span>(<span class="number">16</span>)]));</code></pre></div></div></details></section></div></main></body></html> |