blob: 2d91d5a0d61e05630a7da930668bec5d5652fda5 [file] [log] [blame]
<!--
SPDX-FileCopyrightText: The Apache Software Foundation
SPDX-License-Identifier: Apache-2.0
-->
<!DOCTYPE html>
<html lang="en">
<head>
<title>Arrow.RoundMode</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="utf-8" />
<meta property="og:type" content="website"/>
<meta property="og:title" content="Arrow.RoundMode"/>
<meta property="og:description" content="Reference for Arrow.RoundMode"/>
<meta name="twitter:title" content="Arrow.RoundMode"/>
<meta name="twitter:description" content="Reference for Arrow.RoundMode"/>
<meta name="twitter:card" content="summary"/>
<link rel="stylesheet" href="style.css" type="text/css" />
<script src="urlmap.js"></script>
<script src="fzy.js"></script>
<script src="search.js"></script>
<script src="main.js"></script>
</head>
<body>
<div id="body-wrapper" tabindex="-1">
<nav class="sidebar devhelp-hidden">
<div class="search section">
<form id="search-form" autocomplete="off">
<input id="search-input" type="text" name="do-not-autocomplete" placeholder="Click, or press 's' to search" autocomplete="off"/>
</form>
</div>
<div class="section namespace">
<h3><a href="index.html">Arrow</a></h3>
<p>API Version: 1.0</p>
<p>Library Version: 22.0.0.dev</p>
</div>
<div class="section">
<h5>Type</h5>
<div class="links">
<a class="current" href="enum.RoundMode.html">RoundMode</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
</div>
</nav>
<button id="btn-to-top" class="hidden"><span class="up-arrow"></span></button>
<section id="main" class="content">
<header>
<h3>Enumeration</h3>
<h1><a href="index.html">Arrow</a><span class="sep"></span>RoundMode</h1>
</header>
<section>
<div class="docblock">
<p><span class="emblem available">since: 7.0.0</span></p>
</div>
<div class="declaration toggle-wrapper">
<h4 style="display:flex;" id="declaration">
Declaration
<a href="#declaration" class="anchor"></a>
</h4>
<div class="docblock">
<pre><code>enum Arrow.RoundMode</code></pre>
</div>
</div>
<div class="description toggle-wrapper">
<h4 style="display:flex;" id="description">
Description
<a href="#description" class="anchor"></a>
<a class="srclink" title="go to source location" href="https://github.com/apache/arrow/blob/main/c_glib/arrow-glib/compute.h#L604">[src]</a>
</h4>
<div class="docblock">
<p>They correspond to the values of <code>arrow::compute::RoundMode</code>.</p>
</div>
<div class="docblock">
<p>Available since: 7.0.0</p>
</div>
</div>
<div class="members toggle-wrapper">
<h4 id="members">
Members
<a href="#members" class="anchor"></a>
</h4>
<div class="docblock">
<table class="enum-members">
<tr>
<th>Name</th>
<th>Description</th>
</tr>
<tr>
<td><a id="down" href="#down"><code title="Value: 0">GARROW_ROUND_DOWN</code></a></td>
<td>No description available.</td>
</tr>
<tr>
<td><a id="up" href="#up"><code title="Value: 1">GARROW_ROUND_UP</code></a></td>
<td>No description available.</td>
</tr>
<tr>
<td><a id="towards_zero" href="#towards_zero"><code title="Value: 2">GARROW_ROUND_TOWARDS_ZERO</code></a></td>
<td><p>Get the integral part without fractional digits (aka &#8220;trunc&#8221;)
<code>GARROW_ROUND_TOWARDS_INFINITY</code>,
Round negative values with <code>GARROW_ROUND_MODE_DOWN</code> rule
and positive values with <span class="caps">UP</span> rule (aka &#8220;away from zero&#8221;)
<code>GARROW_ROUND_HALF_DOWN</code>,
Round ties with <code>GARROW_ROUND_MODE_DOWN</code> rule
(also called &#8220;round half towards negative infinity&#8221;)
<code>GARROW_ROUND_HALF_UP</code>,
Round ties with <code>GARROW_ROUND_MODE_UP</code> rule
(also called &#8220;round half towards positive infinity&#8221;)
<code>GARROW_ROUND_HALF_TOWARDS_ZERO</code>,
Round ties with GARROW_ROUND_MODE_TOWARDS_ZERO rule
(also called &#8220;round half away from infinity&#8221;)
<code>GARROW_ROUND_HALF_TOWARDS_INFINITY</code>,
Round ties with GARROW_ROUND_MODE_TOWARDS_INFINITY rule
(also called &#8220;round half away from zero&#8221;)
<code>GARROW_ROUND_HALF_TO_EVEN</code>,
Round ties to nearest even integer
<code>GARROW_ROUND_HALF_TO_ODD</code>,
Round ties to nearest odd&nbsp;integer.</p></td>
</tr>
<tr>
<td><a id="towards_infinity" href="#towards_infinity"><code title="Value: 3">GARROW_ROUND_TOWARDS_INFINITY</code></a></td>
<td>No description available.</td>
</tr>
<tr>
<td><a id="half_down" href="#half_down"><code title="Value: 4">GARROW_ROUND_HALF_DOWN</code></a></td>
<td>No description available.</td>
</tr>
<tr>
<td><a id="half_up" href="#half_up"><code title="Value: 5">GARROW_ROUND_HALF_UP</code></a></td>
<td>No description available.</td>
</tr>
<tr>
<td><a id="half_towards_zero" href="#half_towards_zero"><code title="Value: 6">GARROW_ROUND_HALF_TOWARDS_ZERO</code></a></td>
<td>No description available.</td>
</tr>
<tr>
<td><a id="half_towards_infinity" href="#half_towards_infinity"><code title="Value: 7">GARROW_ROUND_HALF_TOWARDS_INFINITY</code></a></td>
<td>No description available.</td>
</tr>
<tr>
<td><a id="half_to_even" href="#half_to_even"><code title="Value: 8">GARROW_ROUND_HALF_TO_EVEN</code></a></td>
<td>No description available.</td>
</tr>
<tr>
<td><a id="half_to_odd" href="#half_to_odd"><code title="Value: 9">GARROW_ROUND_HALF_TO_ODD</code></a></td>
<td>No description available.</td>
</tr>
</table>
</div>
</div>
</section>
</section>
<div id="toc" class="toc">
<nav aria-labelledby="toc-title">
<p id="toc-title">Content</p>
<ul class="toc-list">
<li class="toc-list-item"><a href="#description"><span class="link-text">Description</span></a></li>
<li class="toc-list-item"><a href="#members"><span class="link-text">Members</span></a></li>
</ul>
</nav>
</div>
<section id="search" class="content hidden"></section>
<footer>
</footer>
</div>
</body>
</html>