Skip to content

Commit

Permalink
Regen java docs (#104)
Browse files Browse the repository at this point in the history 
* Regen java docs

* Regen docs with Java 21

* Regen docs with Java 17
  • Loading branch information
@stephen29xie
stephen29xie authored Dec 17, 2024
1 parent dad8276 commit af3c0e9
Show file tree
Hide file tree
Showing 80 changed files with 7,614 additions and 7,189 deletions.
4 changes: 2 additions & 2 deletions docs/java/allclasses-index.html
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Fri Dec 13 16:48:08 EST 2024 -->
<!-- Generated by javadoc (17) on Tue Dec 17 13:17:12 EST 2024 -->
<title>All Classes and Interfaces (voyager 2.1.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2024-12-13">
<meta name="dc.created" content="2024-12-17">
<meta name="description" content="class index">
<meta name="generator" content="javadoc/AllClassesIndexWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
Expand Down
4 changes: 2 additions & 2 deletions docs/java/allpackages-index.html
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Fri Dec 13 16:48:08 EST 2024 -->
<!-- Generated by javadoc (17) on Tue Dec 17 13:17:12 EST 2024 -->
<title>All Packages (voyager 2.1.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2024-12-13">
<meta name="dc.created" content="2024-12-17">
<meta name="description" content="package index">
<meta name="generator" content="javadoc/AllPackagesIndexWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
Expand Down
485 changes: 178 additions & 307 deletions docs/java/com/spotify/voyager/jni/Index.QueryResults.html
View file

Large diffs are not rendered by default.

452 changes: 159 additions & 293 deletions docs/java/com/spotify/voyager/jni/Index.SpaceType.html
View file

Large diffs are not rendered by default.

452 changes: 159 additions & 293 deletions docs/java/com/spotify/voyager/jni/Index.StorageDataType.html
View file

Large diffs are not rendered by default.

1,641 changes: 697 additions & 944 deletions docs/java/com/spotify/voyager/jni/Index.html
View file

Large diffs are not rendered by default.

452 changes: 161 additions & 291 deletions docs/java/com/spotify/voyager/jni/StringIndex.QueryResults.html
View file

Large diffs are not rendered by default.

978 changes: 405 additions & 573 deletions docs/java/com/spotify/voyager/jni/StringIndex.html
View file

Large diffs are not rendered by default.

258 changes: 88 additions & 170 deletions docs/java/com/spotify/voyager/jni/class-use/Index.QueryResults.html
View file
Original file line number Diff line number Diff line change
@@ -1,196 +1,114 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_432) on Fri Dec 13 16:58:43 EST 2024 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<!-- Generated by javadoc (17) on Tue Dec 17 13:17:12 EST 2024 -->
<title>Uses of Class com.spotify.voyager.jni.Index.QueryResults (voyager 2.1.0 API)</title>
<meta name="date" content="2024-12-13">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2024-12-17">
<meta name="description" content="use: package: com.spotify.voyager.jni, class: Index, class: QueryResults">
<meta name="generator" content="javadoc/ClassUseWriter">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Uses of Class com.spotify.voyager.jni.Index.QueryResults (voyager 2.1.0 API)";
}
}
catch(err) {
}
//-->
</script>
<body class="class-use-page">
<script type="text/javascript">var pathtoroot = "../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= 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>
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="../package-summary.html">Package</a></li>
<li><a href="../../../../../com/spotify/voyager/jni/Index.QueryResults.html" title="class in com.spotify.voyager.jni">Class</a></li>
<li class="navBarCell1Rev">Use</li>
<li><a href="../Index.QueryResults.html" title="class in com.spotify.voyager.jni">Class</a></li>
<li class="nav-bar-cell1-rev">Use</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>
<li><a href="../../../../../help-doc.html#use">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/spotify/voyager/jni/class-use/Index.QueryResults.html" target="_top">Frames</a></li>
<li><a href="Index.QueryResults.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 class="sub-nav">
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h2 title="Uses of Class com.spotify.voyager.jni.Index.QueryResults" class="title">Uses of Class<br>com.spotify.voyager.jni.Index.QueryResults</h2>
<h1 title="Uses of Class com.spotify.voyager.jni.Index.QueryResults" class="title">Uses of Class<br>com.spotify.voyager.jni.Index.QueryResults</h1>
</div>
<div class="classUseContainer">
<ul class="blockList">
<li class="blockList">
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation">
<caption><span>Packages that use <a href="../../../../../com/spotify/voyager/jni/Index.QueryResults.html" title="class in com.spotify.voyager.jni">Index.QueryResults</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="#com.spotify.voyager.jni">com.spotify.voyager.jni</a></td>
<td class="colLast">
<div class="caption"><span>Packages that use <a href="../Index.QueryResults.html" title="class in com.spotify.voyager.jni">Index.QueryResults</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Package</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="#com.spotify.voyager.jni">com.spotify.voyager.jni</a></div>
<div class="col-last even-row-color">
<div class="block">Java Native Interface (JNI) bindings to expose functionality from Voyager's C++ code into Java.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<ul class="blockList">
<li class="blockList"><a name="com.spotify.voyager.jni">
<!-- -->
</a>
<h3>Uses of <a href="../../../../../com/spotify/voyager/jni/Index.QueryResults.html" title="class in com.spotify.voyager.jni">Index.QueryResults</a> in <a href="../../../../../com/spotify/voyager/jni/package-summary.html">com.spotify.voyager.jni</a></h3>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
<caption><span>Methods in <a href="../../../../../com/spotify/voyager/jni/package-summary.html">com.spotify.voyager.jni</a> that return <a href="../../../../../com/spotify/voyager/jni/Index.QueryResults.html" title="class in com.spotify.voyager.jni">Index.QueryResults</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../com/spotify/voyager/jni/Index.QueryResults.html" title="class in com.spotify.voyager.jni">Index.QueryResults</a>[]</code></td>
<td class="colLast"><span class="typeNameLabel">Index.</span><code><span class="memberNameLink"><a href="../../../../../com/spotify/voyager/jni/Index.html#query-float:A:A-int-int-">query</a></span>(float[][]&nbsp;queryVectors,
int&nbsp;k,
int&nbsp;numThreads)</code>
<div class="block">Query this <a href="../../../../../com/spotify/voyager/jni/Index.html" title="class in com.spotify.voyager.jni"><code>Index</code></a> for approximate nearest neighbors of multiple query vectors.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../com/spotify/voyager/jni/Index.QueryResults.html" title="class in com.spotify.voyager.jni">Index.QueryResults</a>[]</code></td>
<td class="colLast"><span class="typeNameLabel">Index.</span><code><span class="memberNameLink"><a href="../../../../../com/spotify/voyager/jni/Index.html#query-float:A:A-int-int-long-">query</a></span>(float[][]&nbsp;queryVectors,
int&nbsp;k,
int&nbsp;numThreads,
long&nbsp;queryEf)</code>
<div class="block">Query this <a href="../../../../../com/spotify/voyager/jni/Index.html" title="class in com.spotify.voyager.jni"><code>Index</code></a> for approximate nearest neighbors of multiple query vectors.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../com/spotify/voyager/jni/Index.QueryResults.html" title="class in com.spotify.voyager.jni">Index.QueryResults</a></code></td>
<td class="colLast"><span class="typeNameLabel">Index.</span><code><span class="memberNameLink"><a href="../../../../../com/spotify/voyager/jni/Index.html#query-float:A-int-">query</a></span>(float[]&nbsp;queryVector,
int&nbsp;k)</code>
<div class="block">Query this <a href="../../../../../com/spotify/voyager/jni/Index.html" title="class in com.spotify.voyager.jni"><code>Index</code></a> for approximate nearest neighbors of a single query vector.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../com/spotify/voyager/jni/Index.QueryResults.html" title="class in com.spotify.voyager.jni">Index.QueryResults</a></code></td>
<td class="colLast"><span class="typeNameLabel">Index.</span><code><span class="memberNameLink"><a href="../../../../../com/spotify/voyager/jni/Index.html#query-float:A-int-long-">query</a></span>(float[]&nbsp;queryVector,
int&nbsp;k,
long&nbsp;queryEf)</code>
<div class="block">Query this <a href="../../../../../com/spotify/voyager/jni/Index.html" title="class in com.spotify.voyager.jni"><code>Index</code></a> for approximate nearest neighbors of a single query vector.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</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><a href="../package-summary.html">Package</a></li>
<li><a href="../../../../../com/spotify/voyager/jni/Index.QueryResults.html" title="class in com.spotify.voyager.jni">Class</a></li>
<li class="navBarCell1Rev">Use</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>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/spotify/voyager/jni/class-use/Index.QueryResults.html" target="_top">Frames</a></li>
<li><a href="Index.QueryResults.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>
<section class="class-uses">
<ul class="block-list">
<li>
<section class="detail" id="com.spotify.voyager.jni">
<h2>Uses of <a href="../Index.QueryResults.html" title="class in com.spotify.voyager.jni">Index.QueryResults</a> in <a href="../package-summary.html">com.spotify.voyager.jni</a></h2>
<div class="caption"><span>Methods in <a href="../package-summary.html">com.spotify.voyager.jni</a> that return <a href="../Index.QueryResults.html" title="class in com.spotify.voyager.jni">Index.QueryResults</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code><a href="../Index.QueryResults.html" title="class in com.spotify.voyager.jni">Index.QueryResults</a>[]</code></div>
<div class="col-second even-row-color"><span class="type-name-label">Index.</span><code><a href="../Index.html#query(float%5B%5D%5B%5D,int,int)" class="member-name-link">query</a><wbr>(float[][]&nbsp;queryVectors,
int&nbsp;k,
int&nbsp;numThreads)</code></div>
<div class="col-last even-row-color">
<div class="block">Query this <a href="../Index.html" title="class in com.spotify.voyager.jni"><code>Index</code></a> for approximate nearest neighbors of multiple query vectors.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../Index.QueryResults.html" title="class in com.spotify.voyager.jni">Index.QueryResults</a>[]</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">Index.</span><code><a href="../Index.html#query(float%5B%5D%5B%5D,int,int,long)" class="member-name-link">query</a><wbr>(float[][]&nbsp;queryVectors,
int&nbsp;k,
int&nbsp;numThreads,
long&nbsp;queryEf)</code></div>
<div class="col-last odd-row-color">
<div class="block">Query this <a href="../Index.html" title="class in com.spotify.voyager.jni"><code>Index</code></a> for approximate nearest neighbors of multiple query vectors.</div>
</div>
<div class="col-first even-row-color"><code><a href="../Index.QueryResults.html" title="class in com.spotify.voyager.jni">Index.QueryResults</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">Index.</span><code><a href="../Index.html#query(float%5B%5D,int)" class="member-name-link">query</a><wbr>(float[]&nbsp;queryVector,
int&nbsp;k)</code></div>
<div class="col-last even-row-color">
<div class="block">Query this <a href="../Index.html" title="class in com.spotify.voyager.jni"><code>Index</code></a> for approximate nearest neighbors of a single query vector.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../Index.QueryResults.html" title="class in com.spotify.voyager.jni">Index.QueryResults</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">Index.</span><code><a href="../Index.html#query(float%5B%5D,int,long)" class="member-name-link">query</a><wbr>(float[]&nbsp;queryVector,
int&nbsp;k,
long&nbsp;queryEf)</code></div>
<div class="col-last odd-row-color">
<div class="block">Query this <a href="../Index.html" title="class in com.spotify.voyager.jni"><code>Index</code></a> for approximate nearest neighbors of a single query vector.</div>
</div>
</div>
</section>
</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>
</section>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2024. All rights reserved.</small></p>
</footer>
</div>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2024. All rights reserved.</small></p>
</body>
</html>
Loading

0 comments on commit af3c0e9

Please sign in to comment.