blob: 6721201e81f16941209c346faf0290f7157a9590 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>DataSizeRoundingUtil (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DataSizeRoundingUtil (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/DataSizeRoundingUtil.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/arrow/vector/util/CallBack.html" title="interface in org.apache.arrow.vector.util"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/arrow/vector/util/DateUtility.html" title="class in org.apache.arrow.vector.util"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/arrow/vector/util/DataSizeRoundingUtil.html" target="_top">Frames</a></li>
<li><a href="DataSizeRoundingUtil.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.arrow.vector.util</div>
<h2 title="Class DataSizeRoundingUtil" class="title">Class DataSizeRoundingUtil</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.arrow.vector.util.DataSizeRoundingUtil</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class <span class="typeNameLabel">DataSizeRoundingUtil</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Utilities for rounding data size.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/util/DataSizeRoundingUtil.html#DIVIDE_BY_8_SHIFT_BITS">DIVIDE_BY_8_SHIFT_BITS</a></span></code>
<div class="block">The number of bits to shift for dividing by 8.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/util/DataSizeRoundingUtil.html#ROUND_8_MASK_INT">ROUND_8_MASK_INT</a></span></code>
<div class="block">The mask for rounding an integer to a multiple of 8.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/util/DataSizeRoundingUtil.html#ROUND_8_MASK_LONG">ROUND_8_MASK_LONG</a></span></code>
<div class="block">The mask for rounding a long integer to a multiple of 8.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/util/DataSizeRoundingUtil.html#divideBy8Ceil-int-">divideBy8Ceil</a></span>(int&nbsp;input)</code>
<div class="block">A fast way to compute Math.ceil(input / 8.0).</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/util/DataSizeRoundingUtil.html#divideBy8Ceil-long-">divideBy8Ceil</a></span>(long&nbsp;input)</code>
<div class="block">A fast way to compute Math.ceil(input / 8.0).</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/util/DataSizeRoundingUtil.html#roundDownTo8Multiple-int-">roundDownTo8Multiple</a></span>(int&nbsp;input)</code>
<div class="block">Round down the number to the nearest multiple of 8.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/util/DataSizeRoundingUtil.html#roundDownTo8Multiple-long-">roundDownTo8Multiple</a></span>(long&nbsp;input)</code>
<div class="block">Round down the number to the nearest multiple of 8.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/util/DataSizeRoundingUtil.html#roundUpTo8Multiple-int-">roundUpTo8Multiple</a></span>(int&nbsp;input)</code>
<div class="block">Round up the number to the nearest multiple of 8.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/util/DataSizeRoundingUtil.html#roundUpTo8Multiple-long-">roundUpTo8Multiple</a></span>(long&nbsp;input)</code>
<div class="block">Round up the number to the nearest multiple of 8.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/util/DataSizeRoundingUtil.html#roundUpToMultipleOf16-long-">roundUpToMultipleOf16</a></span>(long&nbsp;num)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="ROUND_8_MASK_INT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ROUND_8_MASK_INT</h4>
<pre>public static&nbsp;int ROUND_8_MASK_INT</pre>
<div class="block">The mask for rounding an integer to a multiple of 8.
(i.e. clear the lowest 3 bits)</div>
</li>
</ul>
<a name="ROUND_8_MASK_LONG">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ROUND_8_MASK_LONG</h4>
<pre>public static&nbsp;long ROUND_8_MASK_LONG</pre>
<div class="block">The mask for rounding a long integer to a multiple of 8.
(i.e. clear the lowest 3 bits)</div>
</li>
</ul>
<a name="DIVIDE_BY_8_SHIFT_BITS">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DIVIDE_BY_8_SHIFT_BITS</h4>
<pre>public static&nbsp;int DIVIDE_BY_8_SHIFT_BITS</pre>
<div class="block">The number of bits to shift for dividing by 8.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="roundUpTo8Multiple-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>roundUpTo8Multiple</h4>
<pre>public static&nbsp;int&nbsp;roundUpTo8Multiple(int&nbsp;input)</pre>
<div class="block">Round up the number to the nearest multiple of 8.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>input</code> - the number to round.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the rounded number.</dd>
</dl>
</li>
</ul>
<a name="roundUpTo8Multiple-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>roundUpTo8Multiple</h4>
<pre>public static&nbsp;long&nbsp;roundUpTo8Multiple(long&nbsp;input)</pre>
<div class="block">Round up the number to the nearest multiple of 8.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>input</code> - the number to round.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the rounded number</dd>
</dl>
</li>
</ul>
<a name="roundDownTo8Multiple-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>roundDownTo8Multiple</h4>
<pre>public static&nbsp;int&nbsp;roundDownTo8Multiple(int&nbsp;input)</pre>
<div class="block">Round down the number to the nearest multiple of 8.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>input</code> - the number to round.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the rounded number.</dd>
</dl>
</li>
</ul>
<a name="roundDownTo8Multiple-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>roundDownTo8Multiple</h4>
<pre>public static&nbsp;long&nbsp;roundDownTo8Multiple(long&nbsp;input)</pre>
<div class="block">Round down the number to the nearest multiple of 8.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>input</code> - the number to round.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the rounded number</dd>
</dl>
</li>
</ul>
<a name="divideBy8Ceil-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>divideBy8Ceil</h4>
<pre>public static&nbsp;int&nbsp;divideBy8Ceil(int&nbsp;input)</pre>
<div class="block">A fast way to compute Math.ceil(input / 8.0).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>input</code> - the input number.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the computed number.</dd>
</dl>
</li>
</ul>
<a name="divideBy8Ceil-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>divideBy8Ceil</h4>
<pre>public static&nbsp;long&nbsp;divideBy8Ceil(long&nbsp;input)</pre>
<div class="block">A fast way to compute Math.ceil(input / 8.0).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>input</code> - the input number.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the computed number.</dd>
</dl>
</li>
</ul>
<a name="roundUpToMultipleOf16-long-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>roundUpToMultipleOf16</h4>
<pre>public static&nbsp;long&nbsp;roundUpToMultipleOf16(long&nbsp;num)</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/DataSizeRoundingUtil.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/arrow/vector/util/CallBack.html" title="interface in org.apache.arrow.vector.util"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/arrow/vector/util/DateUtility.html" title="class in org.apache.arrow.vector.util"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/arrow/vector/util/DataSizeRoundingUtil.html" target="_top">Frames</a></li>
<li><a href="DataSizeRoundingUtil.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>