Google Git
Sign in
apache / incubator-retired-pirk / df373d63f79ef66513aab97d34523100d0796f58 / . / docs / org / apache / pirk / query / wideskies / Query.html
blob: a42f31464f9c9bfa2db4d5a526c99458b622b507 [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 (version 1.7.0_80) on Fri Aug 12 15:29:43 EDT 2016 -->
<title>Query</title>
<meta name="date" content="2016-08-12">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Query";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/Query.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-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../../org/apache/pirk/query/wideskies/QueryInfo.html" title="class in org.apache.pirk.query.wideskies"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/pirk/query/wideskies/Query.html" target="_top">Frames</a></li>
<li><a href="Query.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All 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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&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.pirk.query.wideskies</div>
<h2 title="Class Query" class="title">Class Query</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.pirk.query.wideskies.Query</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable, <a href="../../../../../org/apache/pirk/serialization/Storable.html" title="interface in org.apache.pirk.serialization">Storable</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">Query</span>
extends java.lang.Object
implements java.io.Serializable, <a href="../../../../../org/apache/pirk/serialization/Storable.html" title="interface in org.apache.pirk.serialization">Storable</a></pre>
<div class="block">Class to hold the PIR query vectors</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../serialized-form.html#org.apache.pirk.query.wideskies.Query">Serialized Form</a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/Query.html#Query(org.apache.pirk.query.wideskies.QueryInfo,%20java.math.BigInteger)">Query</a></strong>(<a href="../../../../../org/apache/pirk/query/wideskies/QueryInfo.html" title="class in org.apache.pirk.query.wideskies">QueryInfo</a>&nbsp;queryInfoIn,
java.math.BigInteger&nbsp;NInput)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</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>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/Query.html#addQueryElement(java.lang.Integer,%20java.math.BigInteger)">addQueryElement</a></strong>(java.lang.Integer&nbsp;index,
java.math.BigInteger&nbsp;element)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/Query.html#addQueryElements(java.util.TreeMap)">addQueryElements</a></strong>(java.util.TreeMap&lt;java.lang.Integer,java.math.BigInteger&gt;&nbsp;elements)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/Query.html#clearElements()">clearElements</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/Query.html#containsElement(java.math.BigInteger)">containsElement</a></strong>(java.math.BigInteger&nbsp;element)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/Query.html#generateExpTable(int)">generateExpTable</a></strong>(int&nbsp;numThreads)</code>
<div class="block">This should be called after all query elements have been added in order to generate the expTable.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.math.BigInteger</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/Query.html#getExp(java.math.BigInteger,%20int)">getExp</a></strong>(java.math.BigInteger&nbsp;value,
int&nbsp;power)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/Query.html#getExpFile(int)">getExpFile</a></strong>(int&nbsp;i)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.HashMap&lt;java.lang.Integer,java.lang.String&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/Query.html#getExpFileBasedLookup()">getExpFileBasedLookup</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.HashMap&lt;java.math.BigInteger,java.util.HashMap&lt;java.lang.Integer,java.math.BigInteger&gt;&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/Query.html#getExpTable()">getExpTable</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.math.BigInteger</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/Query.html#getN()">getN</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.math.BigInteger</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/Query.html#getNSquared()">getNSquared</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.math.BigInteger</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/Query.html#getQueryElement(int)">getQueryElement</a></strong>(int&nbsp;index)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.TreeMap&lt;java.lang.Integer,java.math.BigInteger&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/Query.html#getQueryElements()">getQueryElements</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/pirk/query/wideskies/QueryInfo.html" title="class in org.apache.pirk.query.wideskies">QueryInfo</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/Query.html#getQueryInfo()">getQueryInfo</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/Query.html#setExpFileBasedLookup(java.util.HashMap)">setExpFileBasedLookup</a></strong>(java.util.HashMap&lt;java.lang.Integer,java.lang.String&gt;&nbsp;expInput)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/pirk/query/wideskies/Query.html#setExpTable(java.util.HashMap)">setExpTable</a></strong>(java.util.HashMap&lt;java.math.BigInteger,java.util.HashMap&lt;java.lang.Integer,java.math.BigInteger&gt;&gt;&nbsp;expTableInput)</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.Object</h3>
<code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Query(org.apache.pirk.query.wideskies.QueryInfo, java.math.BigInteger)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Query</h4>
<pre>public&nbsp;Query(<a href="../../../../../org/apache/pirk/query/wideskies/QueryInfo.html" title="class in org.apache.pirk.query.wideskies">QueryInfo</a>&nbsp;queryInfoIn,
java.math.BigInteger&nbsp;NInput)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getQueryInfo()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueryInfo</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/pirk/query/wideskies/QueryInfo.html" title="class in org.apache.pirk.query.wideskies">QueryInfo</a>&nbsp;getQueryInfo()</pre>
</li>
</ul>
<a name="getQueryElements()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueryElements</h4>
<pre>public&nbsp;java.util.TreeMap&lt;java.lang.Integer,java.math.BigInteger&gt;&nbsp;getQueryElements()</pre>
</li>
</ul>
<a name="getQueryElement(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueryElement</h4>
<pre>public&nbsp;java.math.BigInteger&nbsp;getQueryElement(int&nbsp;index)</pre>
</li>
</ul>
<a name="getN()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getN</h4>
<pre>public&nbsp;java.math.BigInteger&nbsp;getN()</pre>
</li>
</ul>
<a name="getNSquared()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNSquared</h4>
<pre>public&nbsp;java.math.BigInteger&nbsp;getNSquared()</pre>
</li>
</ul>
<a name="getExpFileBasedLookup()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExpFileBasedLookup</h4>
<pre>public&nbsp;java.util.HashMap&lt;java.lang.Integer,java.lang.String&gt;&nbsp;getExpFileBasedLookup()</pre>
</li>
</ul>
<a name="getExpFile(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExpFile</h4>
<pre>public&nbsp;java.lang.String&nbsp;getExpFile(int&nbsp;i)</pre>
</li>
</ul>
<a name="setExpFileBasedLookup(java.util.HashMap)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setExpFileBasedLookup</h4>
<pre>public&nbsp;void&nbsp;setExpFileBasedLookup(java.util.HashMap&lt;java.lang.Integer,java.lang.String&gt;&nbsp;expInput)</pre>
</li>
</ul>
<a name="getExpTable()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExpTable</h4>
<pre>public&nbsp;java.util.HashMap&lt;java.math.BigInteger,java.util.HashMap&lt;java.lang.Integer,java.math.BigInteger&gt;&gt;&nbsp;getExpTable()</pre>
</li>
</ul>
<a name="setExpTable(java.util.HashMap)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setExpTable</h4>
<pre>public&nbsp;void&nbsp;setExpTable(java.util.HashMap&lt;java.math.BigInteger,java.util.HashMap&lt;java.lang.Integer,java.math.BigInteger&gt;&gt;&nbsp;expTableInput)</pre>
</li>
</ul>
<a name="addQueryElement(java.lang.Integer, java.math.BigInteger)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addQueryElement</h4>
<pre>public&nbsp;void&nbsp;addQueryElement(java.lang.Integer&nbsp;index,
java.math.BigInteger&nbsp;element)</pre>
</li>
</ul>
<a name="addQueryElements(java.util.TreeMap)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addQueryElements</h4>
<pre>public&nbsp;void&nbsp;addQueryElements(java.util.TreeMap&lt;java.lang.Integer,java.math.BigInteger&gt;&nbsp;elements)</pre>
</li>
</ul>
<a name="containsElement(java.math.BigInteger)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>containsElement</h4>
<pre>public&nbsp;boolean&nbsp;containsElement(java.math.BigInteger&nbsp;element)</pre>
</li>
</ul>
<a name="clearElements()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearElements</h4>
<pre>public&nbsp;void&nbsp;clearElements()</pre>
</li>
</ul>
<a name="generateExpTable(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>generateExpTable</h4>
<pre>public&nbsp;void&nbsp;generateExpTable(int&nbsp;numThreads)
throws java.lang.InterruptedException</pre>
<div class="block">This should be called after all query elements have been added in order to generate the expTable. For int exponentiation with BigIntegers, assumes that
dataPartitionBitSize < 32.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.InterruptedException</code></dd></dl>
</li>
</ul>
<a name="getExp(java.math.BigInteger, int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getExp</h4>
<pre>public&nbsp;java.math.BigInteger&nbsp;getExp(java.math.BigInteger&nbsp;value,
int&nbsp;power)</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/Query.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-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../../org/apache/pirk/query/wideskies/QueryInfo.html" title="class in org.apache.pirk.query.wideskies"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/pirk/query/wideskies/Query.html" target="_top">Frames</a></li>
<li><a href="Query.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All 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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>