Navigation Menu

Skip to content

Commit

Permalink
Update javadocs
Browse files Browse the repository at this point in the history
  • Loading branch information
@davecromberge
davecromberge committed Sep 15, 2021
1 parent 5225df8 commit bcf0ae5
Show file tree
Hide file tree
Showing 58 changed files with 5,921 additions and 7,971 deletions.
32 changes: 17 additions & 15 deletions api/memory/snapshot/apidocs/allclasses-frame.html
View file
Expand Up @@ -2,35 +2,37 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_252) on Fri Jan 22 12:50:17 PST 2021 -->
<!-- Generated by javadoc (1.8.0_282) on Thu Sep 09 23:36:10 BST 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>All Classes (datasketches-memory 1.4.0-SNAPSHOT API)</title>
<meta name="date" content="2021-01-22">
<title>All Classes (datasketches-memory-java8 2.0.0 API)</title>
<meta name="date" content="2021-09-09">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
<body>
<h1 class="bar">All&nbsp;Classes</h1>
<div class="indexContainer">
<ul>
<li><a href="org/apache/datasketches/memory/BaseBuffer.html" title="class in org.apache.datasketches.memory" target="classFrame">BaseBuffer</a></li>
<li><a href="org/apache/datasketches/memory/Buffer.html" title="class in org.apache.datasketches.memory" target="classFrame">Buffer</a></li>
<li><a href="org/apache/datasketches/memory/BaseBuffer.html" title="interface in org.apache.datasketches.memory" target="classFrame"><span class="interfaceName">BaseBuffer</span></a></li>
<li><a href="org/apache/datasketches/memory/BaseState.html" title="interface in org.apache.datasketches.memory" target="classFrame"><span class="interfaceName">BaseState</span></a></li>
<li><a href="org/apache/datasketches/memory/Buffer.html" title="interface in org.apache.datasketches.memory" target="classFrame"><span class="interfaceName">Buffer</span></a></li>
<li><a href="org/apache/datasketches/memory/DefaultMemoryRequestServer.html" title="class in org.apache.datasketches.memory" target="classFrame">DefaultMemoryRequestServer</a></li>
<li><a href="org/apache/datasketches/memory/Handle.html" title="interface in org.apache.datasketches.memory" target="classFrame"><span class="interfaceName">Handle</span></a></li>
<li><a href="org/apache/datasketches/memory/MapHandle.html" title="class in org.apache.datasketches.memory" target="classFrame">MapHandle</a></li>
<li><a href="org/apache/datasketches/memory/Memory.html" title="class in org.apache.datasketches.memory" target="classFrame">Memory</a></li>
<li><a href="org/apache/datasketches/memory/Map.html" title="interface in org.apache.datasketches.memory" target="classFrame"><span class="interfaceName">Map</span></a></li>
<li><a href="org/apache/datasketches/memory/MapHandle.html" title="interface in org.apache.datasketches.memory" target="classFrame"><span class="interfaceName">MapHandle</span></a></li>
<li><a href="org/apache/datasketches/memory/Memory.html" title="interface in org.apache.datasketches.memory" target="classFrame"><span class="interfaceName">Memory</span></a></li>
<li><a href="org/apache/datasketches/memory/MemoryCloseException.html" title="class in org.apache.datasketches.memory" target="classFrame">MemoryCloseException</a></li>
<li><a href="org/apache/datasketches/memory/MemoryException.html" title="class in org.apache.datasketches.memory" target="classFrame">MemoryException</a></li>
<li><a href="org/apache/datasketches/memory/MemoryRequestServer.html" title="interface in org.apache.datasketches.memory" target="classFrame"><span class="interfaceName">MemoryRequestServer</span></a></li>
<li><a href="org/apache/datasketches/memory/MurmurHash3v2.html" title="class in org.apache.datasketches.memory" target="classFrame">MurmurHash3v2</a></li>
<li><a href="org/apache/datasketches/memory/ReadOnlyException.html" title="class in org.apache.datasketches.memory" target="classFrame">ReadOnlyException</a></li>
<li><a href="org/apache/datasketches/memory/UnsafeUtil.html" title="class in org.apache.datasketches.memory" target="classFrame">UnsafeUtil</a></li>
<li><a href="org/apache/datasketches/memory/Utf8CodingException.html" title="class in org.apache.datasketches.memory" target="classFrame">Utf8CodingException</a></li>
<li><a href="org/apache/datasketches/memory/Util.html" title="class in org.apache.datasketches.memory" target="classFrame">Util</a></li>
<li><a href="org/apache/datasketches/memory/Util.RandomCodePoints.html" title="class in org.apache.datasketches.memory" target="classFrame">Util.RandomCodePoints</a></li>
<li><a href="org/apache/datasketches/memory/WritableBuffer.html" title="class in org.apache.datasketches.memory" target="classFrame">WritableBuffer</a></li>
<li><a href="org/apache/datasketches/memory/WritableDirectHandle.html" title="class in org.apache.datasketches.memory" target="classFrame">WritableDirectHandle</a></li>
<li><a href="org/apache/datasketches/memory/WritableBuffer.html" title="interface in org.apache.datasketches.memory" target="classFrame"><span class="interfaceName">WritableBuffer</span></a></li>
<li><a href="org/apache/datasketches/memory/WritableHandle.html" title="interface in org.apache.datasketches.memory" target="classFrame"><span class="interfaceName">WritableHandle</span></a></li>
<li><a href="org/apache/datasketches/memory/WritableMapHandle.html" title="class in org.apache.datasketches.memory" target="classFrame">WritableMapHandle</a></li>
<li><a href="org/apache/datasketches/memory/WritableMemory.html" title="class in org.apache.datasketches.memory" target="classFrame">WritableMemory</a></li>
<li><a href="org/apache/datasketches/memory/XxHash64.html" title="class in org.apache.datasketches.memory" target="classFrame">XxHash64</a></li>
<li><a href="org/apache/datasketches/memory/WritableMap.html" title="interface in org.apache.datasketches.memory" target="classFrame"><span class="interfaceName">WritableMap</span></a></li>
<li><a href="org/apache/datasketches/memory/WritableMapHandle.html" title="interface in org.apache.datasketches.memory" target="classFrame"><span class="interfaceName">WritableMapHandle</span></a></li>
<li><a href="org/apache/datasketches/memory/WritableMemory.html" title="interface in org.apache.datasketches.memory" target="classFrame"><span class="interfaceName">WritableMemory</span></a></li>
<li><a href="org/apache/datasketches/memory/XxHash.html" title="class in org.apache.datasketches.memory" target="classFrame">XxHash</a></li>
</ul>
</div>
</body>
Expand Down
32 changes: 17 additions & 15 deletions api/memory/snapshot/apidocs/allclasses-noframe.html
View file
Expand Up @@ -2,35 +2,37 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_252) on Fri Jan 22 12:50:17 PST 2021 -->
<!-- Generated by javadoc (1.8.0_282) on Thu Sep 09 23:36:10 BST 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>All Classes (datasketches-memory 1.4.0-SNAPSHOT API)</title>
<meta name="date" content="2021-01-22">
<title>All Classes (datasketches-memory-java8 2.0.0 API)</title>
<meta name="date" content="2021-09-09">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
<body>
<h1 class="bar">All&nbsp;Classes</h1>
<div class="indexContainer">
<ul>
<li><a href="org/apache/datasketches/memory/BaseBuffer.html" title="class in org.apache.datasketches.memory">BaseBuffer</a></li>
<li><a href="org/apache/datasketches/memory/Buffer.html" title="class in org.apache.datasketches.memory">Buffer</a></li>
<li><a href="org/apache/datasketches/memory/BaseBuffer.html" title="interface in org.apache.datasketches.memory"><span class="interfaceName">BaseBuffer</span></a></li>
<li><a href="org/apache/datasketches/memory/BaseState.html" title="interface in org.apache.datasketches.memory"><span class="interfaceName">BaseState</span></a></li>
<li><a href="org/apache/datasketches/memory/Buffer.html" title="interface in org.apache.datasketches.memory"><span class="interfaceName">Buffer</span></a></li>
<li><a href="org/apache/datasketches/memory/DefaultMemoryRequestServer.html" title="class in org.apache.datasketches.memory">DefaultMemoryRequestServer</a></li>
<li><a href="org/apache/datasketches/memory/Handle.html" title="interface in org.apache.datasketches.memory"><span class="interfaceName">Handle</span></a></li>
<li><a href="org/apache/datasketches/memory/MapHandle.html" title="class in org.apache.datasketches.memory">MapHandle</a></li>
<li><a href="org/apache/datasketches/memory/Memory.html" title="class in org.apache.datasketches.memory">Memory</a></li>
<li><a href="org/apache/datasketches/memory/Map.html" title="interface in org.apache.datasketches.memory"><span class="interfaceName">Map</span></a></li>
<li><a href="org/apache/datasketches/memory/MapHandle.html" title="interface in org.apache.datasketches.memory"><span class="interfaceName">MapHandle</span></a></li>
<li><a href="org/apache/datasketches/memory/Memory.html" title="interface in org.apache.datasketches.memory"><span class="interfaceName">Memory</span></a></li>
<li><a href="org/apache/datasketches/memory/MemoryCloseException.html" title="class in org.apache.datasketches.memory">MemoryCloseException</a></li>
<li><a href="org/apache/datasketches/memory/MemoryException.html" title="class in org.apache.datasketches.memory">MemoryException</a></li>
<li><a href="org/apache/datasketches/memory/MemoryRequestServer.html" title="interface in org.apache.datasketches.memory"><span class="interfaceName">MemoryRequestServer</span></a></li>
<li><a href="org/apache/datasketches/memory/MurmurHash3v2.html" title="class in org.apache.datasketches.memory">MurmurHash3v2</a></li>
<li><a href="org/apache/datasketches/memory/ReadOnlyException.html" title="class in org.apache.datasketches.memory">ReadOnlyException</a></li>
<li><a href="org/apache/datasketches/memory/UnsafeUtil.html" title="class in org.apache.datasketches.memory">UnsafeUtil</a></li>
<li><a href="org/apache/datasketches/memory/Utf8CodingException.html" title="class in org.apache.datasketches.memory">Utf8CodingException</a></li>
<li><a href="org/apache/datasketches/memory/Util.html" title="class in org.apache.datasketches.memory">Util</a></li>
<li><a href="org/apache/datasketches/memory/Util.RandomCodePoints.html" title="class in org.apache.datasketches.memory">Util.RandomCodePoints</a></li>
<li><a href="org/apache/datasketches/memory/WritableBuffer.html" title="class in org.apache.datasketches.memory">WritableBuffer</a></li>
<li><a href="org/apache/datasketches/memory/WritableDirectHandle.html" title="class in org.apache.datasketches.memory">WritableDirectHandle</a></li>
<li><a href="org/apache/datasketches/memory/WritableBuffer.html" title="interface in org.apache.datasketches.memory"><span class="interfaceName">WritableBuffer</span></a></li>
<li><a href="org/apache/datasketches/memory/WritableHandle.html" title="interface in org.apache.datasketches.memory"><span class="interfaceName">WritableHandle</span></a></li>
<li><a href="org/apache/datasketches/memory/WritableMapHandle.html" title="class in org.apache.datasketches.memory">WritableMapHandle</a></li>
<li><a href="org/apache/datasketches/memory/WritableMemory.html" title="class in org.apache.datasketches.memory">WritableMemory</a></li>
<li><a href="org/apache/datasketches/memory/XxHash64.html" title="class in org.apache.datasketches.memory">XxHash64</a></li>
<li><a href="org/apache/datasketches/memory/WritableMap.html" title="interface in org.apache.datasketches.memory"><span class="interfaceName">WritableMap</span></a></li>
<li><a href="org/apache/datasketches/memory/WritableMapHandle.html" title="interface in org.apache.datasketches.memory"><span class="interfaceName">WritableMapHandle</span></a></li>
<li><a href="org/apache/datasketches/memory/WritableMemory.html" title="interface in org.apache.datasketches.memory"><span class="interfaceName">WritableMemory</span></a></li>
<li><a href="org/apache/datasketches/memory/XxHash.html" title="class in org.apache.datasketches.memory">XxHash</a></li>
</ul>
</div>
</body>
Expand Down
144 changes: 5 additions & 139 deletions api/memory/snapshot/apidocs/constant-values.html
View file
Expand Up @@ -2,18 +2,18 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_252) on Fri Jan 22 12:50:16 PST 2021 -->
<!-- Generated by javadoc (1.8.0_282) on Thu Sep 09 23:36:09 BST 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Constant Field Values (datasketches-memory 1.4.0-SNAPSHOT API)</title>
<meta name="date" content="2021-01-22">
<title>Constant Field Values (datasketches-memory-java8 2.0.0 API)</title>
<meta name="date" content="2021-09-09">
<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="Constant Field Values (datasketches-memory 1.4.0-SNAPSHOT API)";
parent.document.title="Constant Field Values (datasketches-memory-java8 2.0.0 API)";
}
}
catch(err) {
Expand Down Expand Up @@ -73,140 +73,6 @@
<div class="header">
<h1 title="Constant Field Values" class="title">Constant Field Values</h1>
<h2 title="Contents">Contents</h2>
<ul>
<li><a href="#org.apache">org.apache.*</a></li>
</ul>
</div>
<div class="constantValuesContainer"><a name="org.apache">
<!-- -->
</a>
<h2 title="org.apache">org.apache.*</h2>
<ul class="blockList">
<li class="blockList">
<table class="constantsSummary" border="0" cellpadding="3" cellspacing="0" summary="Constant Field Values table, listing constant fields, and values">
<caption><span>org.apache.datasketches.memory.<a href="org/apache/datasketches/memory/UnsafeUtil.html" title="class in org.apache.datasketches.memory">UnsafeUtil</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th scope="col">Constant Field</th>
<th class="colLast" scope="col">Value</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a name="org.apache.datasketches.memory.UnsafeUtil.ARRAY_BOOLEAN_INDEX_SCALE">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;int</code></td>
<td><code><a href="org/apache/datasketches/memory/UnsafeUtil.html#ARRAY_BOOLEAN_INDEX_SCALE">ARRAY_BOOLEAN_INDEX_SCALE</a></code></td>
<td class="colLast"><code>1</code></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a name="org.apache.datasketches.memory.UnsafeUtil.ARRAY_BYTE_INDEX_SCALE">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;int</code></td>
<td><code><a href="org/apache/datasketches/memory/UnsafeUtil.html#ARRAY_BYTE_INDEX_SCALE">ARRAY_BYTE_INDEX_SCALE</a></code></td>
<td class="colLast"><code>1</code></td>
</tr>
<tr class="altColor">
<td class="colFirst"><a name="org.apache.datasketches.memory.UnsafeUtil.ARRAY_CHAR_INDEX_SCALE">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;long</code></td>
<td><code><a href="org/apache/datasketches/memory/UnsafeUtil.html#ARRAY_CHAR_INDEX_SCALE">ARRAY_CHAR_INDEX_SCALE</a></code></td>
<td class="colLast"><code>2L</code></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a name="org.apache.datasketches.memory.UnsafeUtil.ARRAY_DOUBLE_INDEX_SCALE">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;long</code></td>
<td><code><a href="org/apache/datasketches/memory/UnsafeUtil.html#ARRAY_DOUBLE_INDEX_SCALE">ARRAY_DOUBLE_INDEX_SCALE</a></code></td>
<td class="colLast"><code>8L</code></td>
</tr>
<tr class="altColor">
<td class="colFirst"><a name="org.apache.datasketches.memory.UnsafeUtil.ARRAY_FLOAT_INDEX_SCALE">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;long</code></td>
<td><code><a href="org/apache/datasketches/memory/UnsafeUtil.html#ARRAY_FLOAT_INDEX_SCALE">ARRAY_FLOAT_INDEX_SCALE</a></code></td>
<td class="colLast"><code>4L</code></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a name="org.apache.datasketches.memory.UnsafeUtil.ARRAY_INT_INDEX_SCALE">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;long</code></td>
<td><code><a href="org/apache/datasketches/memory/UnsafeUtil.html#ARRAY_INT_INDEX_SCALE">ARRAY_INT_INDEX_SCALE</a></code></td>
<td class="colLast"><code>4L</code></td>
</tr>
<tr class="altColor">
<td class="colFirst"><a name="org.apache.datasketches.memory.UnsafeUtil.ARRAY_LONG_INDEX_SCALE">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;long</code></td>
<td><code><a href="org/apache/datasketches/memory/UnsafeUtil.html#ARRAY_LONG_INDEX_SCALE">ARRAY_LONG_INDEX_SCALE</a></code></td>
<td class="colLast"><code>8L</code></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a name="org.apache.datasketches.memory.UnsafeUtil.ARRAY_SHORT_INDEX_SCALE">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;long</code></td>
<td><code><a href="org/apache/datasketches/memory/UnsafeUtil.html#ARRAY_SHORT_INDEX_SCALE">ARRAY_SHORT_INDEX_SCALE</a></code></td>
<td class="colLast"><code>2L</code></td>
</tr>
<tr class="altColor">
<td class="colFirst"><a name="org.apache.datasketches.memory.UnsafeUtil.BOOLEAN_SHIFT">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;int</code></td>
<td><code><a href="org/apache/datasketches/memory/UnsafeUtil.html#BOOLEAN_SHIFT">BOOLEAN_SHIFT</a></code></td>
<td class="colLast"><code>0</code></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a name="org.apache.datasketches.memory.UnsafeUtil.BYTE_SHIFT">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;int</code></td>
<td><code><a href="org/apache/datasketches/memory/UnsafeUtil.html#BYTE_SHIFT">BYTE_SHIFT</a></code></td>
<td class="colLast"><code>0</code></td>
</tr>
<tr class="altColor">
<td class="colFirst"><a name="org.apache.datasketches.memory.UnsafeUtil.CHAR_SHIFT">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;long</code></td>
<td><code><a href="org/apache/datasketches/memory/UnsafeUtil.html#CHAR_SHIFT">CHAR_SHIFT</a></code></td>
<td class="colLast"><code>1L</code></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a name="org.apache.datasketches.memory.UnsafeUtil.DOUBLE_SHIFT">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;long</code></td>
<td><code><a href="org/apache/datasketches/memory/UnsafeUtil.html#DOUBLE_SHIFT">DOUBLE_SHIFT</a></code></td>
<td class="colLast"><code>3L</code></td>
</tr>
<tr class="altColor">
<td class="colFirst"><a name="org.apache.datasketches.memory.UnsafeUtil.FLOAT_SHIFT">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;long</code></td>
<td><code><a href="org/apache/datasketches/memory/UnsafeUtil.html#FLOAT_SHIFT">FLOAT_SHIFT</a></code></td>
<td class="colLast"><code>2L</code></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a name="org.apache.datasketches.memory.UnsafeUtil.INT_SHIFT">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;long</code></td>
<td><code><a href="org/apache/datasketches/memory/UnsafeUtil.html#INT_SHIFT">INT_SHIFT</a></code></td>
<td class="colLast"><code>2L</code></td>
</tr>
<tr class="altColor">
<td class="colFirst"><a name="org.apache.datasketches.memory.UnsafeUtil.LONG_SHIFT">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;long</code></td>
<td><code><a href="org/apache/datasketches/memory/UnsafeUtil.html#LONG_SHIFT">LONG_SHIFT</a></code></td>
<td class="colLast"><code>3L</code></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a name="org.apache.datasketches.memory.UnsafeUtil.SHORT_SHIFT">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;long</code></td>
<td><code><a href="org/apache/datasketches/memory/UnsafeUtil.html#SHORT_SHIFT">SHORT_SHIFT</a></code></td>
<td class="colLast"><code>1L</code></td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
Expand Down Expand Up @@ -255,6 +121,6 @@ <h2 title="org.apache">org.apache.*</h2>
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2015&#x2013;2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
<p class="legalCopy"><small>Copyright &#169; 2015&#x2013;2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>

0 comments on commit bcf0ae5

Please sign in to comment.