blob: b4fdd71b577933738950e3005913afe7e5e4529e [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 (1.8.0_121) on Fri Apr 14 22:11:37 PDT 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>FeatureVectorEncoder (Mahout Map-Reduce 0.13.0 API)</title>
<meta name="date" content="2017-04-14">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="FeatureVectorEncoder (Mahout Map-Reduce 0.13.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":10,"i2":10,"i3":10,"i4":6,"i5":9,"i6":10,"i7":10,"i8":10,"i9":10,"i10":9,"i11":10,"i12":9,"i13":10,"i14":10,"i15":6,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/FeatureVectorEncoder.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/mahout/vectorizer/encoders/Dictionary.html" title="class in org.apache.mahout.vectorizer.encoders"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/mahout/vectorizer/encoders/InteractionValueEncoder.html" title="class in org.apache.mahout.vectorizer.encoders"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/mahout/vectorizer/encoders/FeatureVectorEncoder.html" target="_top">Frames</a></li>
<li><a href="FeatureVectorEncoder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&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">org.apache.mahout.vectorizer.encoders</div>
<h2 title="Class FeatureVectorEncoder" class="title">Class FeatureVectorEncoder</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.mahout.vectorizer.encoders.FeatureVectorEncoder</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../org/apache/mahout/vectorizer/encoders/CachingValueEncoder.html" title="class in org.apache.mahout.vectorizer.encoders">CachingValueEncoder</a>, <a href="../../../../../org/apache/mahout/vectorizer/encoders/InteractionValueEncoder.html" title="class in org.apache.mahout.vectorizer.encoders">InteractionValueEncoder</a>, <a href="../../../../../org/apache/mahout/vectorizer/encoders/TextValueEncoder.html" title="class in org.apache.mahout.vectorizer.encoders">TextValueEncoder</a>, <a href="../../../../../org/apache/mahout/vectorizer/encoders/WordValueEncoder.html" title="class in org.apache.mahout.vectorizer.encoders">WordValueEncoder</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">FeatureVectorEncoder</span>
extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">General interface for objects that record features into a feature vector.
<p/>
By convention, sub-classes should provide a constructor that accepts just a field name as well as
setters to customize properties of the conversion such as adding tokenizers or a weight
dictionary.</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>
<table class="memberSummary" 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 static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/vectorizer/encoders/FeatureVectorEncoder.html#CONTINUOUS_VALUE_HASH_SEED">CONTINUOUS_VALUE_HASH_SEED</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/vectorizer/encoders/FeatureVectorEncoder.html#WORD_LIKE_VALUE_HASH_SEED">WORD_LIKE_VALUE_HASH_SEED</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" 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="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/vectorizer/encoders/FeatureVectorEncoder.html#FeatureVectorEncoder-java.lang.String-">FeatureVectorEncoder</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/vectorizer/encoders/FeatureVectorEncoder.html#FeatureVectorEncoder-java.lang.String-int-">FeatureVectorEncoder</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
int&nbsp;probes)</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/vectorizer/encoders/FeatureVectorEncoder.html#addToVector-byte:A-double-org.apache.mahout.math.Vector-">addToVector</a></span>(byte[]&nbsp;originalForm,
double&nbsp;weight,
<a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Vector.html?is-external=true" title="class or interface in org.apache.mahout.math">Vector</a>&nbsp;data)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/vectorizer/encoders/FeatureVectorEncoder.html#addToVector-byte:A-org.apache.mahout.math.Vector-">addToVector</a></span>(byte[]&nbsp;originalForm,
<a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Vector.html?is-external=true" title="class or interface in org.apache.mahout.math">Vector</a>&nbsp;data)</code>
<div class="block">Adds a value expressed in byte array form to a vector.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/vectorizer/encoders/FeatureVectorEncoder.html#addToVector-java.lang.String-double-org.apache.mahout.math.Vector-">addToVector</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;originalForm,
double&nbsp;weight,
<a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Vector.html?is-external=true" title="class or interface in org.apache.mahout.math">Vector</a>&nbsp;data)</code>
<div class="block">Adds a weighted value expressed in string form to a vector.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/vectorizer/encoders/FeatureVectorEncoder.html#addToVector-java.lang.String-org.apache.mahout.math.Vector-">addToVector</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;originalForm,
<a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Vector.html?is-external=true" title="class or interface in org.apache.mahout.math">Vector</a>&nbsp;data)</code>
<div class="block">Adds a value expressed in string form to a vector.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/vectorizer/encoders/FeatureVectorEncoder.html#asString-java.lang.String-">asString</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;originalForm)</code>
<div class="block">Converts a value into a form that would help a human understand the internals of how the value
is being interpreted.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected static byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/vectorizer/encoders/FeatureVectorEncoder.html#bytesForString-java.lang.String-">bytesForString</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;x)</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/vectorizer/encoders/FeatureVectorEncoder.html#getName--">getName</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/vectorizer/encoders/FeatureVectorEncoder.html#getProbes--">getProbes</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>protected double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/vectorizer/encoders/FeatureVectorEncoder.html#getWeight-byte:A-double-">getWeight</a></span>(byte[]&nbsp;originalForm,
double&nbsp;w)</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/vectorizer/encoders/FeatureVectorEncoder.html#hash-byte:A-byte:A-int-int-">hash</a></span>(byte[]&nbsp;term1,
byte[]&nbsp;term2,
int&nbsp;probe,
int&nbsp;numFeatures)</code>
<div class="block">Hash two byte arrays and an integer into the range [0..numFeatures-1].</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>protected static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/vectorizer/encoders/FeatureVectorEncoder.html#hash-byte:A-int-int-">hash</a></span>(byte[]&nbsp;term,
int&nbsp;probe,
int&nbsp;numFeatures)</code>
<div class="block">Hash a byte array and an integer into the range [0..numFeatures-1].</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/vectorizer/encoders/FeatureVectorEncoder.html#hash-java.lang.String-int-int-">hash</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;term,
int&nbsp;probe,
int&nbsp;numFeatures)</code>
<div class="block">Hash a string and an integer into the range [0..numFeatures-1].</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>protected static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/vectorizer/encoders/FeatureVectorEncoder.html#hash-java.lang.String-java.lang.String-int-int-">hash</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;term1,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;term2,
int&nbsp;probe,
int&nbsp;numFeatures)</code>
<div class="block">Hash two strings and an integer into the range [0..numFeatures-1].</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/vectorizer/encoders/FeatureVectorEncoder.html#hash-java.lang.String-java.lang.String-java.lang.String-java.lang.String-int-int-">hash</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;term1,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;term2,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;term3,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;term4,
int&nbsp;probe,
int&nbsp;numFeatures)</code>
<div class="block">Hash four strings and an integer into the range [0..numFeatures-1].</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/vectorizer/encoders/FeatureVectorEncoder.html#hashesForProbe-byte:A-int-java.lang.String-int-">hashesForProbe</a></span>(byte[]&nbsp;originalForm,
int&nbsp;dataSize,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
int&nbsp;probe)</code>
<div class="block">Returns all of the hashes for this probe.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>protected abstract int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/vectorizer/encoders/FeatureVectorEncoder.html#hashForProbe-byte:A-int-java.lang.String-int-">hashForProbe</a></span>(byte[]&nbsp;originalForm,
int&nbsp;dataSize,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
int&nbsp;probe)</code>
<div class="block">Provides the unique hash for a particular probe.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/vectorizer/encoders/FeatureVectorEncoder.html#isTraceEnabled--">isTraceEnabled</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/vectorizer/encoders/FeatureVectorEncoder.html#setProbes-int-">setProbes</a></span>(int&nbsp;probes)</code>
<div class="block">Sets the number of locations in the feature vector that a value should be in.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/vectorizer/encoders/FeatureVectorEncoder.html#setTraceDictionary-java.util.Map-">setTraceDictionary</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&gt;&gt;&nbsp;traceDictionary)</code>&nbsp;</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/vectorizer/encoders/FeatureVectorEncoder.html#trace-byte:A-int-">trace</a></span>(byte[]&nbsp;subName,
int&nbsp;n)</code>&nbsp;</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/vectorizer/encoders/FeatureVectorEncoder.html#trace-java.lang.String-int-">trace</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;subName,
int&nbsp;n)</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.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></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="CONTINUOUS_VALUE_HASH_SEED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CONTINUOUS_VALUE_HASH_SEED</h4>
<pre>protected static final&nbsp;int CONTINUOUS_VALUE_HASH_SEED</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.mahout.vectorizer.encoders.FeatureVectorEncoder.CONTINUOUS_VALUE_HASH_SEED">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="WORD_LIKE_VALUE_HASH_SEED">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>WORD_LIKE_VALUE_HASH_SEED</h4>
<pre>protected static final&nbsp;int WORD_LIKE_VALUE_HASH_SEED</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.mahout.vectorizer.encoders.FeatureVectorEncoder.WORD_LIKE_VALUE_HASH_SEED">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="FeatureVectorEncoder-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FeatureVectorEncoder</h4>
<pre>protected&nbsp;FeatureVectorEncoder(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
</li>
</ul>
<a name="FeatureVectorEncoder-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FeatureVectorEncoder</h4>
<pre>protected&nbsp;FeatureVectorEncoder(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
int&nbsp;probes)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="addToVector-java.lang.String-org.apache.mahout.math.Vector-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addToVector</h4>
<pre>public&nbsp;void&nbsp;addToVector(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;originalForm,
<a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Vector.html?is-external=true" title="class or interface in org.apache.mahout.math">Vector</a>&nbsp;data)</pre>
<div class="block">Adds a value expressed in string form to a vector.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>originalForm</code> - The original form of the value as a string.</dd>
<dd><code>data</code> - The vector to which the value should be added.</dd>
</dl>
</li>
</ul>
<a name="addToVector-byte:A-org.apache.mahout.math.Vector-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addToVector</h4>
<pre>public&nbsp;void&nbsp;addToVector(byte[]&nbsp;originalForm,
<a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Vector.html?is-external=true" title="class or interface in org.apache.mahout.math">Vector</a>&nbsp;data)</pre>
<div class="block">Adds a value expressed in byte array form to a vector.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>originalForm</code> - The original form of the value as a byte array.</dd>
<dd><code>data</code> - The vector to which the value should be added.</dd>
</dl>
</li>
</ul>
<a name="addToVector-java.lang.String-double-org.apache.mahout.math.Vector-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addToVector</h4>
<pre>public&nbsp;void&nbsp;addToVector(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;originalForm,
double&nbsp;weight,
<a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Vector.html?is-external=true" title="class or interface in org.apache.mahout.math">Vector</a>&nbsp;data)</pre>
<div class="block">Adds a weighted value expressed in string form to a vector. In some cases it is convenient to
use this method to encode continuous values using the weight as the value. In such cases, the
string value should typically be set to null.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>originalForm</code> - The original form of the value as a string.</dd>
<dd><code>weight</code> - The weight to be applied to this feature.</dd>
<dd><code>data</code> - The vector to which the value should be added.</dd>
</dl>
</li>
</ul>
<a name="addToVector-byte:A-double-org.apache.mahout.math.Vector-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addToVector</h4>
<pre>public abstract&nbsp;void&nbsp;addToVector(byte[]&nbsp;originalForm,
double&nbsp;weight,
<a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Vector.html?is-external=true" title="class or interface in org.apache.mahout.math">Vector</a>&nbsp;data)</pre>
</li>
</ul>
<a name="hashForProbe-byte:A-int-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashForProbe</h4>
<pre>protected abstract&nbsp;int&nbsp;hashForProbe(byte[]&nbsp;originalForm,
int&nbsp;dataSize,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
int&nbsp;probe)</pre>
<div class="block">Provides the unique hash for a particular probe. For all encoders except text, this
is all that is needed and the default implementation of hashesForProbe will do the right
thing. For text and similar values, hashesForProbe should be over-ridden and this method
should not be used.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>originalForm</code> - The original byte array value</dd>
<dd><code>dataSize</code> - The length of the vector being encoded</dd>
<dd><code>name</code> - The name of the variable being encoded</dd>
<dd><code>probe</code> - The probe number</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The hash of the current probe</dd>
</dl>
</li>
</ul>
<a name="hashesForProbe-byte:A-int-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashesForProbe</h4>
<pre>protected&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&gt;&nbsp;hashesForProbe(byte[]&nbsp;originalForm,
int&nbsp;dataSize,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
int&nbsp;probe)</pre>
<div class="block">Returns all of the hashes for this probe. For most encoders, this is a singleton, but
for text, many hashes are returned, one for each word (unique or not). Most implementations
should only implement hashForProbe for simplicity.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>originalForm</code> - The original byte array value.</dd>
<dd><code>dataSize</code> - The length of the vector being encoded</dd>
<dd><code>name</code> - The name of the variable being encoded</dd>
<dd><code>probe</code> - The probe number</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an Iterable of the hashes</dd>
</dl>
</li>
</ul>
<a name="getWeight-byte:A-double-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWeight</h4>
<pre>protected&nbsp;double&nbsp;getWeight(byte[]&nbsp;originalForm,
double&nbsp;w)</pre>
</li>
</ul>
<a name="hash-java.lang.String-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hash</h4>
<pre>protected&nbsp;int&nbsp;hash(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;term,
int&nbsp;probe,
int&nbsp;numFeatures)</pre>
<div class="block">Hash a string and an integer into the range [0..numFeatures-1].</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>term</code> - The string.</dd>
<dd><code>probe</code> - An integer that modifies the resulting hash.</dd>
<dd><code>numFeatures</code> - The range into which the resulting hash must fit.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An integer in the range [0..numFeatures-1] that has good spread for small changes in
term and probe.</dd>
</dl>
</li>
</ul>
<a name="hash-byte:A-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hash</h4>
<pre>protected static&nbsp;int&nbsp;hash(byte[]&nbsp;term,
int&nbsp;probe,
int&nbsp;numFeatures)</pre>
<div class="block">Hash a byte array and an integer into the range [0..numFeatures-1].</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>term</code> - The bytes.</dd>
<dd><code>probe</code> - An integer that modifies the resulting hash.</dd>
<dd><code>numFeatures</code> - The range into which the resulting hash must fit.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An integer in the range [0..numFeatures-1] that has good spread for small changes in
term and probe.</dd>
</dl>
</li>
</ul>
<a name="hash-java.lang.String-java.lang.String-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hash</h4>
<pre>protected static&nbsp;int&nbsp;hash(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;term1,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;term2,
int&nbsp;probe,
int&nbsp;numFeatures)</pre>
<div class="block">Hash two strings and an integer into the range [0..numFeatures-1].</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>term1</code> - The first string.</dd>
<dd><code>term2</code> - The second string.</dd>
<dd><code>probe</code> - An integer that modifies the resulting hash.</dd>
<dd><code>numFeatures</code> - The range into which the resulting hash must fit.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An integer in the range [0..numFeatures-1] that has good spread for small changes in
term and probe.</dd>
</dl>
</li>
</ul>
<a name="hash-byte:A-byte:A-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hash</h4>
<pre>protected&nbsp;int&nbsp;hash(byte[]&nbsp;term1,
byte[]&nbsp;term2,
int&nbsp;probe,
int&nbsp;numFeatures)</pre>
<div class="block">Hash two byte arrays and an integer into the range [0..numFeatures-1].</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>term1</code> - The first string.</dd>
<dd><code>term2</code> - The second string.</dd>
<dd><code>probe</code> - An integer that modifies the resulting hash.</dd>
<dd><code>numFeatures</code> - The range into which the resulting hash must fit.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An integer in the range [0..numFeatures-1] that has good spread for small changes in
term and probe.</dd>
</dl>
</li>
</ul>
<a name="hash-java.lang.String-java.lang.String-java.lang.String-java.lang.String-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hash</h4>
<pre>protected&nbsp;int&nbsp;hash(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;term1,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;term2,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;term3,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;term4,
int&nbsp;probe,
int&nbsp;numFeatures)</pre>
<div class="block">Hash four strings and an integer into the range [0..numFeatures-1].</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>term1</code> - The first string.</dd>
<dd><code>term2</code> - The second string.</dd>
<dd><code>term3</code> - The third string</dd>
<dd><code>term4</code> - And the fourth.</dd>
<dd><code>probe</code> - An integer that modifies the resulting hash.</dd>
<dd><code>numFeatures</code> - The range into which the resulting hash must fit.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An integer in the range [0..numFeatures-1] that has good spread for small changes in
term and probe.</dd>
</dl>
</li>
</ul>
<a name="asString-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>asString</h4>
<pre>public abstract&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;asString(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;originalForm)</pre>
<div class="block">Converts a value into a form that would help a human understand the internals of how the value
is being interpreted. For text-like things, this is likely to be a list of the terms found
with associated weights (if any).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>originalForm</code> - The original form of the value as a string.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A string that a human can read.</dd>
</dl>
</li>
</ul>
<a name="getProbes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProbes</h4>
<pre>public&nbsp;int&nbsp;getProbes()</pre>
</li>
</ul>
<a name="setProbes-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setProbes</h4>
<pre>public&nbsp;void&nbsp;setProbes(int&nbsp;probes)</pre>
<div class="block">Sets the number of locations in the feature vector that a value should be in.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>probes</code> - Number of locations to increment.</dd>
</dl>
</li>
</ul>
<a name="getName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getName()</pre>
</li>
</ul>
<a name="isTraceEnabled--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isTraceEnabled</h4>
<pre>protected&nbsp;boolean&nbsp;isTraceEnabled()</pre>
</li>
</ul>
<a name="trace-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>trace</h4>
<pre>protected&nbsp;void&nbsp;trace(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;subName,
int&nbsp;n)</pre>
</li>
</ul>
<a name="trace-byte:A-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>trace</h4>
<pre>protected&nbsp;void&nbsp;trace(byte[]&nbsp;subName,
int&nbsp;n)</pre>
</li>
</ul>
<a name="setTraceDictionary-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTraceDictionary</h4>
<pre>public&nbsp;void&nbsp;setTraceDictionary(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&gt;&gt;&nbsp;traceDictionary)</pre>
</li>
</ul>
<a name="bytesForString-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>bytesForString</h4>
<pre>protected static&nbsp;byte[]&nbsp;bytesForString(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;x)</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>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/FeatureVectorEncoder.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/mahout/vectorizer/encoders/Dictionary.html" title="class in org.apache.mahout.vectorizer.encoders"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/mahout/vectorizer/encoders/InteractionValueEncoder.html" title="class in org.apache.mahout.vectorizer.encoders"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/mahout/vectorizer/encoders/FeatureVectorEncoder.html" target="_top">Frames</a></li>
<li><a href="FeatureVectorEncoder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&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 ======= -->
<p class="legalCopy"><small>Copyright &#169; 2008&#x2013;2017 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>