blob: 2aa8fb973599af03b7f5151f822501f7de5eb01f [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>org.apache.arrow.memory.util (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="org.apache.arrow.memory.util (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
</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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/memory/unsafe/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/apache/arrow/memory/util/hash/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/arrow/memory/util/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.arrow.memory.util</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/memory/util/ArrowBufPointer.html" title="class in org.apache.arrow.memory.util">ArrowBufPointer</a></td>
<td class="colLast">
<div class="block">Pointer to a memory region within an <a href="../../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory"><code>ArrowBuf</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/memory/util/ArrowBufPointerBenchmarks.html" title="class in org.apache.arrow.memory.util">ArrowBufPointerBenchmarks</a></td>
<td class="colLast">
<div class="block">Benchmarks for <a href="../../../../../org/apache/arrow/memory/util/ArrowBufPointer.html" title="class in org.apache.arrow.memory.util"><code>ArrowBufPointer</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/memory/util/AssertionUtil.html" title="class in org.apache.arrow.memory.util">AssertionUtil</a></td>
<td class="colLast">
<div class="block">Utility class to that provides <a href="../../../../../org/apache/arrow/memory/util/AssertionUtil.html#ASSERT_ENABLED"><code>AssertionUtil.ASSERT_ENABLED</code></a> constant to determine if assertions are enabled.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/memory/util/AutoCloseableLock.html" title="class in org.apache.arrow.memory.util">AutoCloseableLock</a></td>
<td class="colLast">
<div class="block">Simple wrapper class that allows Locks to be released via a try-with-resources block.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/memory/util/ByteFunctionHelpers.html" title="class in org.apache.arrow.memory.util">ByteFunctionHelpers</a></td>
<td class="colLast">
<div class="block">Utility methods for memory comparison at a byte level.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/memory/util/ByteFunctionHelpersBenchmarks.html" title="class in org.apache.arrow.memory.util">ByteFunctionHelpersBenchmarks</a></td>
<td class="colLast">
<div class="block">Benchmarks for <a href="../../../../../org/apache/arrow/memory/util/ByteFunctionHelpers.html" title="class in org.apache.arrow.memory.util"><code>ByteFunctionHelpers</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/memory/util/ByteFunctionHelpersBenchmarks.ArrowArrayEqualState.html" title="class in org.apache.arrow.memory.util">ByteFunctionHelpersBenchmarks.ArrowArrayEqualState</a></td>
<td class="colLast">
<div class="block">State object for the <a href="../../../../../org/apache/arrow/memory/util/ByteFunctionHelpersBenchmarks.html#arrowBufArrayEquals-org.apache.arrow.memory.util.ByteFunctionHelpersBenchmarks.ArrowArrayEqualState-"><code>ByteFunctionHelpersBenchmarks.arrowBufArrayEquals(ArrowArrayEqualState)</code></a> benchmark.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/memory/util/ByteFunctionHelpersBenchmarks.ArrowEqualState.html" title="class in org.apache.arrow.memory.util">ByteFunctionHelpersBenchmarks.ArrowEqualState</a></td>
<td class="colLast">
<div class="block">State object for the <a href="../../../../../org/apache/arrow/memory/util/ByteFunctionHelpersBenchmarks.html#arrowBufEquals-org.apache.arrow.memory.util.ByteFunctionHelpersBenchmarks.ArrowEqualState-"><code>ByteFunctionHelpersBenchmarks.arrowBufEquals(ArrowEqualState)</code></a> benchmark.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/memory/util/CommonUtil.html" title="class in org.apache.arrow.memory.util">CommonUtil</a></td>
<td class="colLast">
<div class="block">Utilities and static methods needed for arrow-memory.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/memory/util/Float16.html" title="class in org.apache.arrow.memory.util">Float16</a></td>
<td class="colLast">
<div class="block">Lifted from Apache Parquet MR project:
https://github.com/apache/parquet-mr/blob/e87b80308869b77f914fcfd04364686e11158950/parquet-column/src/main/java/org/apache/parquet/schema/Float16.java
Changes made:
Modify the data type input from Parquet-MR Binary (toFloat(Binary b)) to Arrow Java short (toFloat(short b))
Expose NAN and POSITIVE_INFINITY variables
The class is a utility class to manipulate half-precision 16-bit
<a href="https://en.wikipedia.org/wiki/Half-precision_floating-point_format">IEEE 754</a>
floating point data types (also called fp16 or binary16).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/memory/util/HistoricalLog.html" title="class in org.apache.arrow.memory.util">HistoricalLog</a></td>
<td class="colLast">
<div class="block">Utility class that can be used to log activity within a class
for later logging and debugging.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/memory/util/LargeMemoryUtil.html" title="class in org.apache.arrow.memory.util">LargeMemoryUtil</a></td>
<td class="colLast">
<div class="block">Contains utilities for dealing with a 64-bit address base.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/memory/util/MemoryUtil.html" title="class in org.apache.arrow.memory.util">MemoryUtil</a></td>
<td class="colLast">
<div class="block">Utilities for memory related operations.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/arrow/memory/util/StackTrace.html" title="class in org.apache.arrow.memory.util">StackTrace</a></td>
<td class="colLast">
<div class="block">Convenient way of obtaining and manipulating stack traces for debugging.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/memory/unsafe/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/apache/arrow/memory/util/hash/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/arrow/memory/util/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<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>