datafu-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mha...@apache.org
Subject svn commit: r1827525 [10/49] - in /datafu/site/docs: datafu/1.4.0/ datafu/1.4.0/datafu/ datafu/1.4.0/datafu/pig/ datafu/1.4.0/datafu/pig/bags/ datafu/1.4.0/datafu/pig/geo/ datafu/1.4.0/datafu/pig/hash/ datafu/1.4.0/datafu/pig/hash/lsh/ datafu/1.4.0/dat...
Date Thu, 22 Mar 2018 19:01:10 GMT
Added: datafu/site/docs/datafu/1.4.0/datafu/pig/hash/lsh/metric/L2.html
URL: http://svn.apache.org/viewvc/datafu/site/docs/datafu/1.4.0/datafu/pig/hash/lsh/metric/L2.html?rev=1827525&view=auto
==============================================================================
--- datafu/site/docs/datafu/1.4.0/datafu/pig/hash/lsh/metric/L2.html (added)
+++ datafu/site/docs/datafu/1.4.0/datafu/pig/hash/lsh/metric/L2.html Thu Mar 22 19:01:04 2018
@@ -0,0 +1,354 @@
+<!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_79) on Thu Mar 22 11:58:09 PDT 2018 -->
+<title>L2 (datafu-pig 1.4.0 API)</title>
+<meta name="date" content="2018-03-22">
+<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="L2 (datafu-pig 1.4.0 API)";
+    }
+//-->
+</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="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="../../../../../datafu/pig/hash/lsh/metric/L1.html" title="class in datafu.pig.hash.lsh.metric"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../../datafu/pig/hash/lsh/metric/MetricUDF.html" title="class in datafu.pig.hash.lsh.metric"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?datafu/pig/hash/lsh/metric/L2.html" target="_top">Frames</a></li>
+<li><a href="L2.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><a href="#nested_classes_inherited_from_class_org.apache.pig.EvalFunc">Nested</a>&nbsp;|&nbsp;</li>
+<li><a href="#fields_inherited_from_class_datafu.pig.hash.lsh.metric.MetricUDF">Field</a>&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">datafu.pig.hash.lsh.metric</div>
+<h2 title="Class L2" class="title">Class L2</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li>java.lang.Object</li>
+<li>
+<ul class="inheritance">
+<li>org.apache.pig.EvalFunc&lt;org.apache.pig.data.Tuple&gt;</li>
+<li>
+<ul class="inheritance">
+<li><a href="../../../../../datafu/pig/hash/lsh/metric/MetricUDF.html" title="class in datafu.pig.hash.lsh.metric">datafu.pig.hash.lsh.metric.MetricUDF</a></li>
+<li>
+<ul class="inheritance">
+<li>datafu.pig.hash.lsh.metric.L2</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<hr>
+<br>
+<pre>public class <span class="strong">L2</span>
+extends <a href="../../../../../datafu/pig/hash/lsh/metric/MetricUDF.html" title="class in datafu.pig.hash.lsh.metric">MetricUDF</a></pre>
+<div class="block">A UDF used to find a vector v in a bag such that for query point q, metric m and threshold t
+ m(v,q) &lt; t.  In other words, find the first vector in the bag within a threshold distance away.
+
+ <p>
+ It returns one of the tuples of the bag of vectors using <a href="http://en.wikipedia.org/wiki/Lp_space" target="_blank">L2 distance</a>, 
+ distance between two vectors.  This is otherwise known as
+ the Euclidean distance.
+ </p></div>
+<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../datafu/pig/hash/lsh/L2PStableHash.html" title="class in datafu.pig.hash.lsh"><code>L2PStableHash for an example</code></a></dd></dl>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- ======== NESTED CLASS SUMMARY ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="nested_class_summary">
+<!--   -->
+</a>
+<h3>Nested Class Summary</h3>
+<ul class="blockList">
+<li class="blockList"><a name="nested_classes_inherited_from_class_org.apache.pig.EvalFunc">
+<!--   -->
+</a>
+<h3>Nested classes/interfaces inherited from class&nbsp;org.apache.pig.EvalFunc</h3>
+<code>org.apache.pig.EvalFunc.SchemaType</code></li>
+</ul>
+</li>
+</ul>
+<!-- =========== FIELD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="field_summary">
+<!--   -->
+</a>
+<h3>Field Summary</h3>
+<ul class="blockList">
+<li class="blockList"><a name="fields_inherited_from_class_datafu.pig.hash.lsh.metric.MetricUDF">
+<!--   -->
+</a>
+<h3>Fields inherited from class&nbsp;datafu.pig.hash.lsh.metric.<a href="../../../../../datafu/pig/hash/lsh/metric/MetricUDF.html" title="class in datafu.pig.hash.lsh.metric">MetricUDF</a></h3>
+<code><a href="../../../../../datafu/pig/hash/lsh/metric/MetricUDF.html#dim">dim</a></code></li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="fields_inherited_from_class_org.apache.pig.EvalFunc">
+<!--   -->
+</a>
+<h3>Fields inherited from class&nbsp;org.apache.pig.EvalFunc</h3>
+<code>log, pigLogger, reporter, returnType</code></li>
+</ul>
+</li>
+</ul>
+<!-- ======== 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="../../../../../datafu/pig/hash/lsh/metric/L2.html#L2(java.lang.String)">L2</a></strong>(java.lang.String&nbsp;sDim)</code>
+<div class="block">Create a new L2 Metric UDF with a given dimension.</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="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>protected double</code></td>
+<td class="colLast"><code><strong><a href="../../../../../datafu/pig/hash/lsh/metric/L2.html#dist(org.apache.commons.math.linear.RealVector,%20org.apache.commons.math.linear.RealVector)">dist</a></strong>(org.apache.commons.math.linear.RealVector&nbsp;v1,
+    org.apache.commons.math.linear.RealVector&nbsp;v2)</code>
+<div class="block">The distance metric used.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>static double</code></td>
+<td class="colLast"><code><strong><a href="../../../../../datafu/pig/hash/lsh/metric/L2.html#distance(org.apache.commons.math.linear.RealVector,%20org.apache.commons.math.linear.RealVector)">distance</a></strong>(org.apache.commons.math.linear.RealVector&nbsp;v1,
+        org.apache.commons.math.linear.RealVector&nbsp;v2)</code>&nbsp;</td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="methods_inherited_from_class_datafu.pig.hash.lsh.metric.MetricUDF">
+<!--   -->
+</a>
+<h3>Methods inherited from class&nbsp;datafu.pig.hash.lsh.metric.<a href="../../../../../datafu/pig/hash/lsh/metric/MetricUDF.html" title="class in datafu.pig.hash.lsh.metric">MetricUDF</a></h3>
+<code><a href="../../../../../datafu/pig/hash/lsh/metric/MetricUDF.html#exec(org.apache.pig.data.Tuple)">exec</a>, <a href="../../../../../datafu/pig/hash/lsh/metric/MetricUDF.html#outputSchema(org.apache.pig.impl.logicalLayer.schema.Schema)">outputSchema</a></code></li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="methods_inherited_from_class_org.apache.pig.EvalFunc">
+<!--   -->
+</a>
+<h3>Methods inherited from class&nbsp;org.apache.pig.EvalFunc</h3>
+<code>allowCompileTimeCalculation, finish, getArgToFuncMapping, getCacheFiles, getInputSchema, getLogger, getPigLogger, getReporter, getReturnType, getSchemaName, getSchemaType, getShipFiles, isAsynchronous, progress, setInputSchema, setPigLogger, setReporter, setUDFContextSignature, warn</code></li>
+</ul>
+<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>clone, equals, finalize, 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="L2(java.lang.String)">
+<!--   -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>L2</h4>
+<pre>public&nbsp;L2(java.lang.String&nbsp;sDim)</pre>
+<div class="block">Create a new L2 Metric UDF with a given dimension.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sDim</code> - dimension</dd></dl>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_detail">
+<!--   -->
+</a>
+<h3>Method Detail</h3>
+<a name="distance(org.apache.commons.math.linear.RealVector, org.apache.commons.math.linear.RealVector)">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>distance</h4>
+<pre>public static&nbsp;double&nbsp;distance(org.apache.commons.math.linear.RealVector&nbsp;v1,
+              org.apache.commons.math.linear.RealVector&nbsp;v2)</pre>
+</li>
+</ul>
+<a name="dist(org.apache.commons.math.linear.RealVector, org.apache.commons.math.linear.RealVector)">
+<!--   -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>dist</h4>
+<pre>protected&nbsp;double&nbsp;dist(org.apache.commons.math.linear.RealVector&nbsp;v1,
+          org.apache.commons.math.linear.RealVector&nbsp;v2)</pre>
+<div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../../datafu/pig/hash/lsh/metric/MetricUDF.html#dist(org.apache.commons.math.linear.RealVector,%20org.apache.commons.math.linear.RealVector)">MetricUDF</a></code></strong></div>
+<div class="block">The distance metric used.  Given v1 and v2, compute the distance between those vectors.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../../../datafu/pig/hash/lsh/metric/MetricUDF.html#dist(org.apache.commons.math.linear.RealVector,%20org.apache.commons.math.linear.RealVector)">dist</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../datafu/pig/hash/lsh/metric/MetricUDF.html" title="class in datafu.pig.hash.lsh.metric">MetricUDF</a></code></dd>
+<dt><span class="strong">Parameters:</span></dt><dd><code>v1</code> - first vector</dd><dd><code>v2</code> - second vector</dd>
+<dt><span class="strong">Returns:</span></dt><dd>the distance between v1 and v2</dd></dl>
+</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="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="../../../../../datafu/pig/hash/lsh/metric/L1.html" title="class in datafu.pig.hash.lsh.metric"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../../datafu/pig/hash/lsh/metric/MetricUDF.html" title="class in datafu.pig.hash.lsh.metric"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?datafu/pig/hash/lsh/metric/L2.html" target="_top">Frames</a></li>
+<li><a href="L2.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><a href="#nested_classes_inherited_from_class_org.apache.pig.EvalFunc">Nested</a>&nbsp;|&nbsp;</li>
+<li><a href="#fields_inherited_from_class_datafu.pig.hash.lsh.metric.MetricUDF">Field</a>&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>

Added: datafu/site/docs/datafu/1.4.0/datafu/pig/hash/lsh/metric/MetricUDF.html
URL: http://svn.apache.org/viewvc/datafu/site/docs/datafu/1.4.0/datafu/pig/hash/lsh/metric/MetricUDF.html?rev=1827525&view=auto
==============================================================================
--- datafu/site/docs/datafu/1.4.0/datafu/pig/hash/lsh/metric/MetricUDF.html (added)
+++ datafu/site/docs/datafu/1.4.0/datafu/pig/hash/lsh/metric/MetricUDF.html Thu Mar 22 19:01:04 2018
@@ -0,0 +1,394 @@
+<!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_79) on Thu Mar 22 11:58:09 PDT 2018 -->
+<title>MetricUDF (datafu-pig 1.4.0 API)</title>
+<meta name="date" content="2018-03-22">
+<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="MetricUDF (datafu-pig 1.4.0 API)";
+    }
+//-->
+</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="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="../../../../../datafu/pig/hash/lsh/metric/L2.html" title="class in datafu.pig.hash.lsh.metric"><span class="strong">Prev Class</span></a></li>
+<li>Next Class</li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?datafu/pig/hash/lsh/metric/MetricUDF.html" target="_top">Frames</a></li>
+<li><a href="MetricUDF.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><a href="#nested_classes_inherited_from_class_org.apache.pig.EvalFunc">Nested</a>&nbsp;|&nbsp;</li>
+<li><a href="#field_summary">Field</a>&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><a href="#field_detail">Field</a>&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">datafu.pig.hash.lsh.metric</div>
+<h2 title="Class MetricUDF" class="title">Class MetricUDF</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li>java.lang.Object</li>
+<li>
+<ul class="inheritance">
+<li>org.apache.pig.EvalFunc&lt;org.apache.pig.data.Tuple&gt;</li>
+<li>
+<ul class="inheritance">
+<li>datafu.pig.hash.lsh.metric.MetricUDF</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>Direct Known Subclasses:</dt>
+<dd><a href="../../../../../datafu/pig/hash/lsh/metric/Cosine.html" title="class in datafu.pig.hash.lsh.metric">Cosine</a>, <a href="../../../../../datafu/pig/hash/lsh/metric/L1.html" title="class in datafu.pig.hash.lsh.metric">L1</a>, <a href="../../../../../datafu/pig/hash/lsh/metric/L2.html" title="class in datafu.pig.hash.lsh.metric">L2</a></dd>
+</dl>
+<hr>
+<br>
+<pre>public abstract class <span class="strong">MetricUDF</span>
+extends org.apache.pig.EvalFunc&lt;org.apache.pig.data.Tuple&gt;</pre>
+<div class="block">A base UDF used to find a vector v in a bag such that for query point q, metric m and threshold t
+ m(v,q) &lt; t.  In other words, find the first vector in the bag within a threshold distance away.
+
+ <p>
+ It returns one of the tuples of the bag of vectors.  For an example of its use, please see datafu.pig.hash.lsh.CosineDistanceHash.
+ </p></div>
+<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../datafu/pig/hash/lsh/CosineDistanceHash.html" title="class in datafu.pig.hash.lsh"><code>CosineDistanceHash</code></a></dd></dl>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- ======== NESTED CLASS SUMMARY ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="nested_class_summary">
+<!--   -->
+</a>
+<h3>Nested Class Summary</h3>
+<ul class="blockList">
+<li class="blockList"><a name="nested_classes_inherited_from_class_org.apache.pig.EvalFunc">
+<!--   -->
+</a>
+<h3>Nested classes/interfaces inherited from class&nbsp;org.apache.pig.EvalFunc</h3>
+<code>org.apache.pig.EvalFunc.SchemaType</code></li>
+</ul>
+</li>
+</ul>
+<!-- =========== FIELD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="field_summary">
+<!--   -->
+</a>
+<h3>Field Summary</h3>
+<table class="overviewSummary" 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>protected int</code></td>
+<td class="colLast"><code><strong><a href="../../../../../datafu/pig/hash/lsh/metric/MetricUDF.html#dim">dim</a></strong></code>&nbsp;</td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="fields_inherited_from_class_org.apache.pig.EvalFunc">
+<!--   -->
+</a>
+<h3>Fields inherited from class&nbsp;org.apache.pig.EvalFunc</h3>
+<code>log, pigLogger, reporter, returnType</code></li>
+</ul>
+</li>
+</ul>
+<!-- ======== 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="../../../../../datafu/pig/hash/lsh/metric/MetricUDF.html#MetricUDF(java.lang.String)">MetricUDF</a></strong>(java.lang.String&nbsp;sDim)</code>
+<div class="block">Create a new Metric UDF with a given dimension.</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="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>protected abstract double</code></td>
+<td class="colLast"><code><strong><a href="../../../../../datafu/pig/hash/lsh/metric/MetricUDF.html#dist(org.apache.commons.math.linear.RealVector,%20org.apache.commons.math.linear.RealVector)">dist</a></strong>(org.apache.commons.math.linear.RealVector&nbsp;v1,
+    org.apache.commons.math.linear.RealVector&nbsp;v2)</code>
+<div class="block">The distance metric used.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>org.apache.pig.data.Tuple</code></td>
+<td class="colLast"><code><strong><a href="../../../../../datafu/pig/hash/lsh/metric/MetricUDF.html#exec(org.apache.pig.data.Tuple)">exec</a></strong>(org.apache.pig.data.Tuple&nbsp;input)</code>
+<div class="block">This UDF expects a query vector as the first element, a threshold (double) as the second, and a bag of vectors.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>org.apache.pig.impl.logicalLayer.schema.Schema</code></td>
+<td class="colLast"><code><strong><a href="../../../../../datafu/pig/hash/lsh/metric/MetricUDF.html#outputSchema(org.apache.pig.impl.logicalLayer.schema.Schema)">outputSchema</a></strong>(org.apache.pig.impl.logicalLayer.schema.Schema&nbsp;input)</code>
+<div class="block">Create the output schema, based on the input schema.</div>
+</td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="methods_inherited_from_class_org.apache.pig.EvalFunc">
+<!--   -->
+</a>
+<h3>Methods inherited from class&nbsp;org.apache.pig.EvalFunc</h3>
+<code>allowCompileTimeCalculation, finish, getArgToFuncMapping, getCacheFiles, getInputSchema, getLogger, getPigLogger, getReporter, getReturnType, getSchemaName, getSchemaType, getShipFiles, isAsynchronous, progress, setInputSchema, setPigLogger, setReporter, setUDFContextSignature, warn</code></li>
+</ul>
+<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>clone, equals, finalize, 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">
+<!-- ============ FIELD DETAIL =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="field_detail">
+<!--   -->
+</a>
+<h3>Field Detail</h3>
+<a name="dim">
+<!--   -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>dim</h4>
+<pre>protected&nbsp;int dim</pre>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor_detail">
+<!--   -->
+</a>
+<h3>Constructor Detail</h3>
+<a name="MetricUDF(java.lang.String)">
+<!--   -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>MetricUDF</h4>
+<pre>public&nbsp;MetricUDF(java.lang.String&nbsp;sDim)</pre>
+<div class="block">Create a new Metric UDF with a given dimension.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sDim</code> - dimension</dd></dl>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_detail">
+<!--   -->
+</a>
+<h3>Method Detail</h3>
+<a name="dist(org.apache.commons.math.linear.RealVector, org.apache.commons.math.linear.RealVector)">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>dist</h4>
+<pre>protected abstract&nbsp;double&nbsp;dist(org.apache.commons.math.linear.RealVector&nbsp;v1,
+          org.apache.commons.math.linear.RealVector&nbsp;v2)</pre>
+<div class="block">The distance metric used.  Given v1 and v2, compute the distance between those vectors.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>v1</code> - first vector</dd><dd><code>v2</code> - second vector</dd>
+<dt><span class="strong">Returns:</span></dt><dd>the distance between v1 and v2</dd></dl>
+</li>
+</ul>
+<a name="exec(org.apache.pig.data.Tuple)">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>exec</h4>
+<pre>public&nbsp;org.apache.pig.data.Tuple&nbsp;exec(org.apache.pig.data.Tuple&nbsp;input)
+                               throws java.io.IOException</pre>
+<div class="block">This UDF expects a query vector as the first element, a threshold (double) as the second, and a bag of vectors.
+ Vectors are represented by tuples with doubles as elements or bags of tuples representing position and value
+ in the case of sparse vectors.
+
+ <p>
+ It returns one of the tuples of the bag of vectors.  For an example of its use, please see datafu.pig.hash.lsh.CosineDistanceHash.
+ </p></div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code>exec</code>&nbsp;in class&nbsp;<code>org.apache.pig.EvalFunc&lt;org.apache.pig.data.Tuple&gt;</code></dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.io.IOException</code></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../datafu/pig/hash/lsh/CosineDistanceHash.html" title="class in datafu.pig.hash.lsh"><code>CosineDistanceHash</code></a></dd></dl>
+</li>
+</ul>
+<a name="outputSchema(org.apache.pig.impl.logicalLayer.schema.Schema)">
+<!--   -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>outputSchema</h4>
+<pre>public&nbsp;org.apache.pig.impl.logicalLayer.schema.Schema&nbsp;outputSchema(org.apache.pig.impl.logicalLayer.schema.Schema&nbsp;input)</pre>
+<div class="block">Create the output schema, based on the input schema.</div>
+<dl>
+<dt><strong>Overrides:</strong></dt>
+<dd><code>outputSchema</code>&nbsp;in class&nbsp;<code>org.apache.pig.EvalFunc&lt;org.apache.pig.data.Tuple&gt;</code></dd>
+<dt><span class="strong">Returns:</span></dt><dd>the output schema, which is a tuple matching the schema of the third input field.</dd></dl>
+</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="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="../../../../../datafu/pig/hash/lsh/metric/L2.html" title="class in datafu.pig.hash.lsh.metric"><span class="strong">Prev Class</span></a></li>
+<li>Next Class</li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?datafu/pig/hash/lsh/metric/MetricUDF.html" target="_top">Frames</a></li>
+<li><a href="MetricUDF.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><a href="#nested_classes_inherited_from_class_org.apache.pig.EvalFunc">Nested</a>&nbsp;|&nbsp;</li>
+<li><a href="#field_summary">Field</a>&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><a href="#field_detail">Field</a>&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>

Added: datafu/site/docs/datafu/1.4.0/datafu/pig/hash/lsh/metric/package-frame.html
URL: http://svn.apache.org/viewvc/datafu/site/docs/datafu/1.4.0/datafu/pig/hash/lsh/metric/package-frame.html?rev=1827525&view=auto
==============================================================================
--- datafu/site/docs/datafu/1.4.0/datafu/pig/hash/lsh/metric/package-frame.html (added)
+++ datafu/site/docs/datafu/1.4.0/datafu/pig/hash/lsh/metric/package-frame.html Thu Mar 22 19:01:04 2018
@@ -0,0 +1,22 @@
+<!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_79) on Thu Mar 22 11:58:10 PDT 2018 -->
+<title>datafu.pig.hash.lsh.metric (datafu-pig 1.4.0 API)</title>
+<meta name="date" content="2018-03-22">
+<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<h1 class="bar"><a href="../../../../../datafu/pig/hash/lsh/metric/package-summary.html" target="classFrame">datafu.pig.hash.lsh.metric</a></h1>
+<div class="indexContainer">
+<h2 title="Classes">Classes</h2>
+<ul title="Classes">
+<li><a href="Cosine.html" title="class in datafu.pig.hash.lsh.metric" target="classFrame">Cosine</a></li>
+<li><a href="L1.html" title="class in datafu.pig.hash.lsh.metric" target="classFrame">L1</a></li>
+<li><a href="L2.html" title="class in datafu.pig.hash.lsh.metric" target="classFrame">L2</a></li>
+<li><a href="MetricUDF.html" title="class in datafu.pig.hash.lsh.metric" target="classFrame">MetricUDF</a></li>
+</ul>
+</div>
+</body>
+</html>

Added: datafu/site/docs/datafu/1.4.0/datafu/pig/hash/lsh/metric/package-summary.html
URL: http://svn.apache.org/viewvc/datafu/site/docs/datafu/1.4.0/datafu/pig/hash/lsh/metric/package-summary.html?rev=1827525&view=auto
==============================================================================
--- datafu/site/docs/datafu/1.4.0/datafu/pig/hash/lsh/metric/package-summary.html (added)
+++ datafu/site/docs/datafu/1.4.0/datafu/pig/hash/lsh/metric/package-summary.html Thu Mar 22 19:01:04 2018
@@ -0,0 +1,166 @@
+<!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_79) on Thu Mar 22 11:58:10 PDT 2018 -->
+<title>datafu.pig.hash.lsh.metric (datafu-pig 1.4.0 API)</title>
+<meta name="date" content="2018-03-22">
+<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="datafu.pig.hash.lsh.metric (datafu-pig 1.4.0 API)";
+    }
+//-->
+</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 class="navBarCell1Rev">Package</li>
+<li>Class</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="../../../../../datafu/pig/hash/lsh/interfaces/package-summary.html">Prev Package</a></li>
+<li><a href="../../../../../datafu/pig/hash/lsh/p_stable/package-summary.html">Next Package</a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?datafu/pig/hash/lsh/metric/package-summary.html" target="_top">Frames</a></li>
+<li><a href="package-summary.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>
+<a name="skip-navbar_top">
+<!--   -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<div class="header">
+<h1 title="Package" class="title">Package&nbsp;datafu.pig.hash.lsh.metric</h1>
+<div class="docSummary">
+<div class="block">UDFs for different <a href="http://en.wikipedia.org/wiki/Metric_(mathematics)" target="_blank">distance functions</a> (and some similarity functions)
+ used with Locality Sensitive Hashing.</div>
+</div>
+<p>See:&nbsp;<a href="#package_description">Description</a></p>
+</div>
+<div class="contentContainer">
+<ul class="blockList">
+<li class="blockList">
+<table class="packageSummary" 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="../../../../../datafu/pig/hash/lsh/metric/Cosine.html" title="class in datafu.pig.hash.lsh.metric">Cosine</a></td>
+<td class="colLast">
+<div class="block">A UDF used to find a vector v in a bag such that for query point q, metric m and threshold t
+ m(v,q) &lt; t.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a href="../../../../../datafu/pig/hash/lsh/metric/L1.html" title="class in datafu.pig.hash.lsh.metric">L1</a></td>
+<td class="colLast">
+<div class="block">A UDF used to find a vector v in a bag such that for query point q, metric m and threshold t
+ m(v,q) &lt; t.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><a href="../../../../../datafu/pig/hash/lsh/metric/L2.html" title="class in datafu.pig.hash.lsh.metric">L2</a></td>
+<td class="colLast">
+<div class="block">A UDF used to find a vector v in a bag such that for query point q, metric m and threshold t
+ m(v,q) &lt; t.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a href="../../../../../datafu/pig/hash/lsh/metric/MetricUDF.html" title="class in datafu.pig.hash.lsh.metric">MetricUDF</a></td>
+<td class="colLast">
+<div class="block">A base UDF used to find a vector v in a bag such that for query point q, metric m and threshold t
+ m(v,q) &lt; t.</div>
+</td>
+</tr>
+</tbody>
+</table>
+</li>
+</ul>
+<a name="package_description">
+<!--   -->
+</a>
+<h2 title="Package datafu.pig.hash.lsh.metric Description">Package datafu.pig.hash.lsh.metric Description</h2>
+<div class="block">UDFs for different <a href="http://en.wikipedia.org/wiki/Metric_(mathematics)" target="_blank">distance functions</a> (and some similarity functions)
+ used with Locality Sensitive Hashing.</div>
+</div>
+<!-- ======= 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 class="navBarCell1Rev">Package</li>
+<li>Class</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="../../../../../datafu/pig/hash/lsh/interfaces/package-summary.html">Prev Package</a></li>
+<li><a href="../../../../../datafu/pig/hash/lsh/p_stable/package-summary.html">Next Package</a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?datafu/pig/hash/lsh/metric/package-summary.html" target="_top">Frames</a></li>
+<li><a href="package-summary.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>
+<a name="skip-navbar_bottom">
+<!--   -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>

Added: datafu/site/docs/datafu/1.4.0/datafu/pig/hash/lsh/metric/package-tree.html
URL: http://svn.apache.org/viewvc/datafu/site/docs/datafu/1.4.0/datafu/pig/hash/lsh/metric/package-tree.html?rev=1827525&view=auto
==============================================================================
--- datafu/site/docs/datafu/1.4.0/datafu/pig/hash/lsh/metric/package-tree.html (added)
+++ datafu/site/docs/datafu/1.4.0/datafu/pig/hash/lsh/metric/package-tree.html Thu Mar 22 19:01:04 2018
@@ -0,0 +1,136 @@
+<!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_79) on Thu Mar 22 11:58:10 PDT 2018 -->
+<title>datafu.pig.hash.lsh.metric Class Hierarchy (datafu-pig 1.4.0 API)</title>
+<meta name="date" content="2018-03-22">
+<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="datafu.pig.hash.lsh.metric Class Hierarchy (datafu-pig 1.4.0 API)";
+    }
+//-->
+</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</li>
+<li class="navBarCell1Rev">Tree</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="../../../../../datafu/pig/hash/lsh/interfaces/package-tree.html">Prev</a></li>
+<li><a href="../../../../../datafu/pig/hash/lsh/p_stable/package-tree.html">Next</a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?datafu/pig/hash/lsh/metric/package-tree.html" target="_top">Frames</a></li>
+<li><a href="package-tree.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>
+<a name="skip-navbar_top">
+<!--   -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<div class="header">
+<h1 class="title">Hierarchy For Package datafu.pig.hash.lsh.metric</h1>
+<span class="strong">Package Hierarchies:</span>
+<ul class="horizontal">
+<li><a href="../../../../../overview-tree.html">All Packages</a></li>
+</ul>
+</div>
+<div class="contentContainer">
+<h2 title="Class Hierarchy">Class Hierarchy</h2>
+<ul>
+<li type="circle">java.lang.Object
+<ul>
+<li type="circle">org.apache.pig.EvalFunc&lt;T&gt;
+<ul>
+<li type="circle">datafu.pig.hash.lsh.metric.<a href="../../../../../datafu/pig/hash/lsh/metric/MetricUDF.html" title="class in datafu.pig.hash.lsh.metric"><span class="strong">MetricUDF</span></a>
+<ul>
+<li type="circle">datafu.pig.hash.lsh.metric.<a href="../../../../../datafu/pig/hash/lsh/metric/Cosine.html" title="class in datafu.pig.hash.lsh.metric"><span class="strong">Cosine</span></a></li>
+<li type="circle">datafu.pig.hash.lsh.metric.<a href="../../../../../datafu/pig/hash/lsh/metric/L1.html" title="class in datafu.pig.hash.lsh.metric"><span class="strong">L1</span></a></li>
+<li type="circle">datafu.pig.hash.lsh.metric.<a href="../../../../../datafu/pig/hash/lsh/metric/L2.html" title="class in datafu.pig.hash.lsh.metric"><span class="strong">L2</span></a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<!-- ======= 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</li>
+<li class="navBarCell1Rev">Tree</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="../../../../../datafu/pig/hash/lsh/interfaces/package-tree.html">Prev</a></li>
+<li><a href="../../../../../datafu/pig/hash/lsh/p_stable/package-tree.html">Next</a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?datafu/pig/hash/lsh/metric/package-tree.html" target="_top">Frames</a></li>
+<li><a href="package-tree.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>
+<a name="skip-navbar_bottom">
+<!--   -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>

Added: datafu/site/docs/datafu/1.4.0/datafu/pig/hash/lsh/p_stable/AbstractStableDistributionFunction.html
URL: http://svn.apache.org/viewvc/datafu/site/docs/datafu/1.4.0/datafu/pig/hash/lsh/p_stable/AbstractStableDistributionFunction.html?rev=1827525&view=auto
==============================================================================
--- datafu/site/docs/datafu/1.4.0/datafu/pig/hash/lsh/p_stable/AbstractStableDistributionFunction.html (added)
+++ datafu/site/docs/datafu/1.4.0/datafu/pig/hash/lsh/p_stable/AbstractStableDistributionFunction.html Thu Mar 22 19:01:04 2018
@@ -0,0 +1,368 @@
+<!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_79) on Thu Mar 22 11:58:09 PDT 2018 -->
+<title>AbstractStableDistributionFunction (datafu-pig 1.4.0 API)</title>
+<meta name="date" content="2018-03-22">
+<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="AbstractStableDistributionFunction (datafu-pig 1.4.0 API)";
+    }
+//-->
+</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="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 Class</li>
+<li><a href="../../../../../datafu/pig/hash/lsh/p_stable/L1LSH.html" title="class in datafu.pig.hash.lsh.p_stable"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?datafu/pig/hash/lsh/p_stable/AbstractStableDistributionFunction.html" target="_top">Frames</a></li>
+<li><a href="AbstractStableDistributionFunction.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><a href="#fields_inherited_from_class_datafu.pig.hash.lsh.interfaces.LSH">Field</a>&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">datafu.pig.hash.lsh.p_stable</div>
+<h2 title="Class AbstractStableDistributionFunction" class="title">Class AbstractStableDistributionFunction</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li>java.lang.Object</li>
+<li>
+<ul class="inheritance">
+<li><a href="../../../../../datafu/pig/hash/lsh/interfaces/LSH.html" title="class in datafu.pig.hash.lsh.interfaces">datafu.pig.hash.lsh.interfaces.LSH</a></li>
+<li>
+<ul class="inheritance">
+<li>datafu.pig.hash.lsh.p_stable.AbstractStableDistributionFunction</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>Direct Known Subclasses:</dt>
+<dd><a href="../../../../../datafu/pig/hash/lsh/p_stable/L1LSH.html" title="class in datafu.pig.hash.lsh.p_stable">L1LSH</a>, <a href="../../../../../datafu/pig/hash/lsh/p_stable/L2LSH.html" title="class in datafu.pig.hash.lsh.p_stable">L2LSH</a></dd>
+</dl>
+<hr>
+<br>
+<pre>public abstract class <span class="strong">AbstractStableDistributionFunction</span>
+extends <a href="../../../../../datafu/pig/hash/lsh/interfaces/LSH.html" title="class in datafu.pig.hash.lsh.interfaces">LSH</a></pre>
+<div class="block">This is the base-class for all p-stable based locality sensitive hashes. p-stable locality sensitive
+ hashes are defined by a few parameters: a dimension, d , a vector taken from a
+ <a href="http://en.wikipedia.org/wiki/Stable_distribution" target="_blank">k-stable distribution</a>
+ (where k is 1 or 2) and a width of projection, w.
+
+ <p>
+ All p-stable LSH functions are parameterized with a quantization parameter (w or r in
+ the literature , depending on where you look). Consider the following excerpt
+ from Datar, M.; Immorlica, N.; Indyk, P.; Mirrokni, V.S. (2004).
+ "Locality-Sensitive Hashing Scheme Based on p-Stable Distributions".
+ Proceedings of the Symposium on Computational Geometry.
+ </p>
+
+ <p>
+ Decreasing the width of the projection (w) decreases the probability of collision for any two points.
+ Thus, it has the same effect as increasing k . As a result, we would like to set w as small as possible
+ and in this way decrease the number of projections we need to make.
+ </p>
+
+ <p>
+ In the literature, the quantization parameter (or width of the projection) is
+ found empirically given a sample of the data and the likely threshold for
+ the metric. Tuning this parameter is very important for the performance of
+ this algorithm. For more information, see Datar, M.; Immorlica, N.; Indyk,
+ P.; Mirrokni, V.S. (2004).
+ "Locality-Sensitive Hashing Scheme Based on p-Stable Distributions".
+ Proceedings of the Symposium on Computational Geometry.
+ </p></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>
+<ul class="blockList">
+<li class="blockList"><a name="fields_inherited_from_class_datafu.pig.hash.lsh.interfaces.LSH">
+<!--   -->
+</a>
+<h3>Fields inherited from class&nbsp;datafu.pig.hash.lsh.interfaces.<a href="../../../../../datafu/pig/hash/lsh/interfaces/LSH.html" title="class in datafu.pig.hash.lsh.interfaces">LSH</a></h3>
+<code><a href="../../../../../datafu/pig/hash/lsh/interfaces/LSH.html#dim">dim</a>, <a href="../../../../../datafu/pig/hash/lsh/interfaces/LSH.html#rg">rg</a></code></li>
+</ul>
+</li>
+</ul>
+<!-- ======== 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="../../../../../datafu/pig/hash/lsh/p_stable/AbstractStableDistributionFunction.html#AbstractStableDistributionFunction(int,%20double,%20org.apache.commons.math.random.RandomGenerator)">AbstractStableDistributionFunction</a></strong>(int&nbsp;dim,
+                                  double&nbsp;w,
+                                  org.apache.commons.math.random.RandomGenerator&nbsp;rand)</code>
+<div class="block">Constructs a new instance.</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="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>long</code></td>
+<td class="colLast"><code><strong><a href="../../../../../datafu/pig/hash/lsh/p_stable/AbstractStableDistributionFunction.html#apply(org.apache.commons.math.linear.RealVector)">apply</a></strong>(org.apache.commons.math.linear.RealVector&nbsp;vector)</code>
+<div class="block">Compute the LSH for a given vector.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>protected abstract <a href="../../../../../datafu/pig/hash/lsh/interfaces/Sampler.html" title="interface in datafu.pig.hash.lsh.interfaces">Sampler</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../../datafu/pig/hash/lsh/p_stable/AbstractStableDistributionFunction.html#getSampler()">getSampler</a></strong>()</code>
+<div class="block">The sampler determines the metric which this LSH is associated with.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../../datafu/pig/hash/lsh/p_stable/AbstractStableDistributionFunction.html#reset(int,%20double)">reset</a></strong>(int&nbsp;dim,
+     double&nbsp;w)</code>&nbsp;</td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="methods_inherited_from_class_datafu.pig.hash.lsh.interfaces.LSH">
+<!--   -->
+</a>
+<h3>Methods inherited from class&nbsp;datafu.pig.hash.lsh.interfaces.<a href="../../../../../datafu/pig/hash/lsh/interfaces/LSH.html" title="class in datafu.pig.hash.lsh.interfaces">LSH</a></h3>
+<code><a href="../../../../../datafu/pig/hash/lsh/interfaces/LSH.html#getDim()">getDim</a>, <a href="../../../../../datafu/pig/hash/lsh/interfaces/LSH.html#getRandomGenerator()">getRandomGenerator</a></code></li>
+</ul>
+<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>clone, equals, finalize, 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="AbstractStableDistributionFunction(int, double, org.apache.commons.math.random.RandomGenerator)">
+<!--   -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>AbstractStableDistributionFunction</h4>
+<pre>public&nbsp;AbstractStableDistributionFunction(int&nbsp;dim,
+                                  double&nbsp;w,
+                                  org.apache.commons.math.random.RandomGenerator&nbsp;rand)
+                                   throws org.apache.commons.math.MathException</pre>
+<div class="block">Constructs a new instance.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dim</code> - The dimension of the vectors to be hashed</dd><dd><code>w</code> - A double representing the quantization parameter (also known as the projection width)</dd><dd><code>rand</code> - The random generator used</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>org.apache.commons.math.MathException</code> - MathException</dd></dl>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_detail">
+<!--   -->
+</a>
+<h3>Method Detail</h3>
+<a name="reset(int, double)">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>reset</h4>
+<pre>public&nbsp;void&nbsp;reset(int&nbsp;dim,
+         double&nbsp;w)
+           throws org.apache.commons.math.MathException</pre>
+<dl><dt><span class="strong">Throws:</span></dt>
+<dd><code>org.apache.commons.math.MathException</code></dd></dl>
+</li>
+</ul>
+<a name="getSampler()">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getSampler</h4>
+<pre>protected abstract&nbsp;<a href="../../../../../datafu/pig/hash/lsh/interfaces/Sampler.html" title="interface in datafu.pig.hash.lsh.interfaces">Sampler</a>&nbsp;getSampler()</pre>
+<div class="block">The sampler determines the metric which this LSH is associated with.
+ A 1-stable sample will yield a LSH which corresponds to a L1 metric; likewise for 2-stable and L2.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>The sampler to use.</dd></dl>
+</li>
+</ul>
+<a name="apply(org.apache.commons.math.linear.RealVector)">
+<!--   -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>apply</h4>
+<pre>public&nbsp;long&nbsp;apply(org.apache.commons.math.linear.RealVector&nbsp;vector)</pre>
+<div class="block">Compute the LSH for a given vector.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../../../datafu/pig/hash/lsh/interfaces/LSH.html#apply(org.apache.commons.math.linear.RealVector)">apply</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../datafu/pig/hash/lsh/interfaces/LSH.html" title="class in datafu.pig.hash.lsh.interfaces">LSH</a></code></dd>
+<dt><span class="strong">Parameters:</span></dt><dd><code>vector</code> - A vector to be hashed</dd>
+<dt><span class="strong">Returns:</span></dt><dd>A hash which collides with vectors close according to some metric (implementation dependent).</dd></dl>
+</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="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 Class</li>
+<li><a href="../../../../../datafu/pig/hash/lsh/p_stable/L1LSH.html" title="class in datafu.pig.hash.lsh.p_stable"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?datafu/pig/hash/lsh/p_stable/AbstractStableDistributionFunction.html" target="_top">Frames</a></li>
+<li><a href="AbstractStableDistributionFunction.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><a href="#fields_inherited_from_class_datafu.pig.hash.lsh.interfaces.LSH">Field</a>&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>

Added: datafu/site/docs/datafu/1.4.0/datafu/pig/hash/lsh/p_stable/L1LSH.html
URL: http://svn.apache.org/viewvc/datafu/site/docs/datafu/1.4.0/datafu/pig/hash/lsh/p_stable/L1LSH.html?rev=1827525&view=auto
==============================================================================
--- datafu/site/docs/datafu/1.4.0/datafu/pig/hash/lsh/p_stable/L1LSH.html (added)
+++ datafu/site/docs/datafu/1.4.0/datafu/pig/hash/lsh/p_stable/L1LSH.html Thu Mar 22 19:01:04 2018
@@ -0,0 +1,344 @@
+<!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_79) on Thu Mar 22 11:58:09 PDT 2018 -->
+<title>L1LSH (datafu-pig 1.4.0 API)</title>
+<meta name="date" content="2018-03-22">
+<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="L1LSH (datafu-pig 1.4.0 API)";
+    }
+//-->
+</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="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="../../../../../datafu/pig/hash/lsh/p_stable/AbstractStableDistributionFunction.html" title="class in datafu.pig.hash.lsh.p_stable"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../../datafu/pig/hash/lsh/p_stable/L2LSH.html" title="class in datafu.pig.hash.lsh.p_stable"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?datafu/pig/hash/lsh/p_stable/L1LSH.html" target="_top">Frames</a></li>
+<li><a href="L1LSH.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><a href="#fields_inherited_from_class_datafu.pig.hash.lsh.interfaces.LSH">Field</a>&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">datafu.pig.hash.lsh.p_stable</div>
+<h2 title="Class L1LSH" class="title">Class L1LSH</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li>java.lang.Object</li>
+<li>
+<ul class="inheritance">
+<li><a href="../../../../../datafu/pig/hash/lsh/interfaces/LSH.html" title="class in datafu.pig.hash.lsh.interfaces">datafu.pig.hash.lsh.interfaces.LSH</a></li>
+<li>
+<ul class="inheritance">
+<li><a href="../../../../../datafu/pig/hash/lsh/p_stable/AbstractStableDistributionFunction.html" title="class in datafu.pig.hash.lsh.p_stable">datafu.pig.hash.lsh.p_stable.AbstractStableDistributionFunction</a></li>
+<li>
+<ul class="inheritance">
+<li>datafu.pig.hash.lsh.p_stable.L1LSH</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Implemented Interfaces:</dt>
+<dd><a href="../../../../../datafu/pig/hash/lsh/interfaces/Sampler.html" title="interface in datafu.pig.hash.lsh.interfaces">Sampler</a></dd>
+</dl>
+<hr>
+<br>
+<pre>public class <span class="strong">L1LSH</span>
+extends <a href="../../../../../datafu/pig/hash/lsh/p_stable/AbstractStableDistributionFunction.html" title="class in datafu.pig.hash.lsh.p_stable">AbstractStableDistributionFunction</a>
+implements <a href="../../../../../datafu/pig/hash/lsh/interfaces/Sampler.html" title="interface in datafu.pig.hash.lsh.interfaces">Sampler</a></pre>
+<div class="block">A locality sensitive hash associated with the L1 metric.  This uses a 1-stable distribution
+ to construct the hash.</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>
+<ul class="blockList">
+<li class="blockList"><a name="fields_inherited_from_class_datafu.pig.hash.lsh.interfaces.LSH">
+<!--   -->
+</a>
+<h3>Fields inherited from class&nbsp;datafu.pig.hash.lsh.interfaces.<a href="../../../../../datafu/pig/hash/lsh/interfaces/LSH.html" title="class in datafu.pig.hash.lsh.interfaces">LSH</a></h3>
+<code><a href="../../../../../datafu/pig/hash/lsh/interfaces/LSH.html#dim">dim</a>, <a href="../../../../../datafu/pig/hash/lsh/interfaces/LSH.html#rg">rg</a></code></li>
+</ul>
+</li>
+</ul>
+<!-- ======== 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="../../../../../datafu/pig/hash/lsh/p_stable/L1LSH.html#L1LSH(int,%20double,%20org.apache.commons.math.random.RandomGenerator)">L1LSH</a></strong>(int&nbsp;dim,
+     double&nbsp;w,
+     org.apache.commons.math.random.RandomGenerator&nbsp;rand)</code>
+<div class="block">Constructs a new instance.</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="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>protected <a href="../../../../../datafu/pig/hash/lsh/interfaces/Sampler.html" title="interface in datafu.pig.hash.lsh.interfaces">Sampler</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../../datafu/pig/hash/lsh/p_stable/L1LSH.html#getSampler()">getSampler</a></strong>()</code>
+<div class="block">The sampler determines the metric which this LSH is associated with.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>double</code></td>
+<td class="colLast"><code><strong><a href="../../../../../datafu/pig/hash/lsh/p_stable/L1LSH.html#sample(org.apache.commons.math.random.RandomDataImpl)">sample</a></strong>(org.apache.commons.math.random.RandomDataImpl&nbsp;randomData)</code>
+<div class="block">Draw a sample s ~ Cauchy(0,1), which is 1-stable.</div>
+</td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="methods_inherited_from_class_datafu.pig.hash.lsh.p_stable.AbstractStableDistributionFunction">
+<!--   -->
+</a>
+<h3>Methods inherited from class&nbsp;datafu.pig.hash.lsh.p_stable.<a href="../../../../../datafu/pig/hash/lsh/p_stable/AbstractStableDistributionFunction.html" title="class in datafu.pig.hash.lsh.p_stable">AbstractStableDistributionFunction</a></h3>
+<code><a href="../../../../../datafu/pig/hash/lsh/p_stable/AbstractStableDistributionFunction.html#apply(org.apache.commons.math.linear.RealVector)">apply</a>, <a href="../../../../../datafu/pig/hash/lsh/p_stable/AbstractStableDistributionFunction.html#reset(int,%20double)">reset</a></code></li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="methods_inherited_from_class_datafu.pig.hash.lsh.interfaces.LSH">
+<!--   -->
+</a>
+<h3>Methods inherited from class&nbsp;datafu.pig.hash.lsh.interfaces.<a href="../../../../../datafu/pig/hash/lsh/interfaces/LSH.html" title="class in datafu.pig.hash.lsh.interfaces">LSH</a></h3>
+<code><a href="../../../../../datafu/pig/hash/lsh/interfaces/LSH.html#getDim()">getDim</a>, <a href="../../../../../datafu/pig/hash/lsh/interfaces/LSH.html#getRandomGenerator()">getRandomGenerator</a></code></li>
+</ul>
+<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>clone, equals, finalize, 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="L1LSH(int, double, org.apache.commons.math.random.RandomGenerator)">
+<!--   -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>L1LSH</h4>
+<pre>public&nbsp;L1LSH(int&nbsp;dim,
+     double&nbsp;w,
+     org.apache.commons.math.random.RandomGenerator&nbsp;rand)
+      throws org.apache.commons.math.MathException</pre>
+<div class="block">Constructs a new instance.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dim</code> - The dimension of the vectors to be hashed</dd><dd><code>w</code> - A double representing the quantization parameter (also known as the projection width)</dd><dd><code>rand</code> - The random generator used</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>org.apache.commons.math.MathException</code> - MathException</dd></dl>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_detail">
+<!--   -->
+</a>
+<h3>Method Detail</h3>
+<a name="sample(org.apache.commons.math.random.RandomDataImpl)">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>sample</h4>
+<pre>public&nbsp;double&nbsp;sample(org.apache.commons.math.random.RandomDataImpl&nbsp;randomData)
+              throws org.apache.commons.math.MathException</pre>
+<div class="block">Draw a sample s ~ Cauchy(0,1), which is 1-stable.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../../../datafu/pig/hash/lsh/interfaces/Sampler.html#sample(org.apache.commons.math.random.RandomDataImpl)">sample</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../datafu/pig/hash/lsh/interfaces/Sampler.html" title="interface in datafu.pig.hash.lsh.interfaces">Sampler</a></code></dd>
+<dt><span class="strong">Parameters:</span></dt><dd><code>randomData</code> - random data generator</dd>
+<dt><span class="strong">Returns:</span></dt><dd>a sample from a cauchy distribution with median 0 and scale 1</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>org.apache.commons.math.MathException</code> - MathException</dd></dl>
+</li>
+</ul>
+<a name="getSampler()">
+<!--   -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>getSampler</h4>
+<pre>protected&nbsp;<a href="../../../../../datafu/pig/hash/lsh/interfaces/Sampler.html" title="interface in datafu.pig.hash.lsh.interfaces">Sampler</a>&nbsp;getSampler()</pre>
+<div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../../datafu/pig/hash/lsh/p_stable/AbstractStableDistributionFunction.html#getSampler()">AbstractStableDistributionFunction</a></code></strong></div>
+<div class="block">The sampler determines the metric which this LSH is associated with.
+ A 1-stable sample will yield a LSH which corresponds to a L1 metric; likewise for 2-stable and L2.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../../../datafu/pig/hash/lsh/p_stable/AbstractStableDistributionFunction.html#getSampler()">getSampler</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../datafu/pig/hash/lsh/p_stable/AbstractStableDistributionFunction.html" title="class in datafu.pig.hash.lsh.p_stable">AbstractStableDistributionFunction</a></code></dd>
+<dt><span class="strong">Returns:</span></dt><dd>The sampler to use.</dd></dl>
+</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="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="../../../../../datafu/pig/hash/lsh/p_stable/AbstractStableDistributionFunction.html" title="class in datafu.pig.hash.lsh.p_stable"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../../datafu/pig/hash/lsh/p_stable/L2LSH.html" title="class in datafu.pig.hash.lsh.p_stable"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?datafu/pig/hash/lsh/p_stable/L1LSH.html" target="_top">Frames</a></li>
+<li><a href="L1LSH.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><a href="#fields_inherited_from_class_datafu.pig.hash.lsh.interfaces.LSH">Field</a>&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>



Mime
View raw message