blob: 1dcfa4221982da38c0a642ed374347c4aa8bc583 [file] [log] [blame]
<!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="Defines numeric arithmetic kernels on `PrimitiveArray`, such as `add`"><title>arrow::compute::kernels::numeric - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../../static.files/rustdoc-dd39b87e5fcfba68.css"><meta name="rustdoc-vars" data-root-path="../../../../" data-static-root-path="../../../../static.files/" data-current-crate="arrow" data-themes="" data-resource-suffix="" data-rustdoc-version="1.80.0-nightly (8c127df75 2024-05-16)" data-channel="nightly" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../../../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../../../../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../../arrow/index.html">arrow</a><span class="version">51.0.0</span></h2></div><h2 class="location"><a href="#">Module numeric</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#functions">Functions</a></li></ul></section><h2><a href="../index.html">In arrow::compute::kernels</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../../../index.html">arrow</a>::<wbr><a href="../../index.html">compute</a>::<wbr><a href="../index.html">kernels</a>::<wbr><a class="mod" href="#">numeric</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Defines numeric arithmetic kernels on <a href="../../../array/struct.PrimitiveArray.html" title="struct arrow::array::PrimitiveArray"><code>PrimitiveArray</code></a>, such as <a href="fn.add.html" title="fn arrow::compute::kernels::numeric::add"><code>add</code></a></p>
</div></details><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">ยง</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.add.html" title="fn arrow::compute::kernels::numeric::add">add</a></div><div class="desc docblock-short">Perform <code>lhs + rhs</code>, returning an error on overflow</div></li><li><div class="item-name"><a class="fn" href="fn.add_wrapping.html" title="fn arrow::compute::kernels::numeric::add_wrapping">add_wrapping</a></div><div class="desc docblock-short">Perform <code>lhs + rhs</code>, wrapping on overflow for <a href="../../../datatypes/enum.DataType.html#method.is_integer" title="method arrow::datatypes::DataType::is_integer"><code>DataType::is_integer</code></a></div></li><li><div class="item-name"><a class="fn" href="fn.div.html" title="fn arrow::compute::kernels::numeric::div">div</a></div><div class="desc docblock-short">Perform <code>lhs / rhs</code></div></li><li><div class="item-name"><a class="fn" href="fn.mul.html" title="fn arrow::compute::kernels::numeric::mul">mul</a></div><div class="desc docblock-short">Perform <code>lhs * rhs</code>, returning an error on overflow</div></li><li><div class="item-name"><a class="fn" href="fn.mul_wrapping.html" title="fn arrow::compute::kernels::numeric::mul_wrapping">mul_wrapping</a></div><div class="desc docblock-short">Perform <code>lhs * rhs</code>, wrapping on overflow for <a href="../../../datatypes/enum.DataType.html#method.is_integer" title="method arrow::datatypes::DataType::is_integer"><code>DataType::is_integer</code></a></div></li><li><div class="item-name"><a class="fn" href="fn.neg.html" title="fn arrow::compute::kernels::numeric::neg">neg</a></div><div class="desc docblock-short">Negates each element of <code>array</code>, returning an error on overflow</div></li><li><div class="item-name"><a class="fn" href="fn.neg_wrapping.html" title="fn arrow::compute::kernels::numeric::neg_wrapping">neg_wrapping</a></div><div class="desc docblock-short">Negates each element of <code>array</code>, wrapping on overflow for <a href="../../../datatypes/enum.DataType.html#method.is_integer" title="method arrow::datatypes::DataType::is_integer"><code>DataType::is_integer</code></a></div></li><li><div class="item-name"><a class="fn" href="fn.rem.html" title="fn arrow::compute::kernels::numeric::rem">rem</a></div><div class="desc docblock-short">Perform <code>lhs % rhs</code></div></li><li><div class="item-name"><a class="fn" href="fn.sub.html" title="fn arrow::compute::kernels::numeric::sub">sub</a></div><div class="desc docblock-short">Perform <code>lhs - rhs</code>, returning an error on overflow</div></li><li><div class="item-name"><a class="fn" href="fn.sub_wrapping.html" title="fn arrow::compute::kernels::numeric::sub_wrapping">sub_wrapping</a></div><div class="desc docblock-short">Perform <code>lhs - rhs</code>, wrapping on overflow for <a href="../../../datatypes/enum.DataType.html#method.is_integer" title="method arrow::datatypes::DataType::is_integer"><code>DataType::is_integer</code></a></div></li></ul></section></div></main></body></html>