blob: a687fff88bbcbf35e0090dd555bfd0071a9cdf86 [file] [log] [blame]
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html>
<head>
<title>indexeddataset - Mahout Math Scala bindings 0.13.0 API - org.apache.mahout.math.indexeddataset</title>
<meta name="description" content="indexeddataset - Mahout Math Scala bindings 0.13.0 API - org.apache.mahout.math.indexeddataset" />
<meta name="keywords" content="indexeddataset Mahout Math Scala bindings 0.13.0 API org.apache.mahout.math.indexeddataset" />
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<link href="../../../../../lib/template.css" media="screen" type="text/css" rel="stylesheet" />
<link href="../../../../../lib/diagrams.css" media="screen" type="text/css" rel="stylesheet" id="diagrams-css" />
<script type="text/javascript">
if(top === self) {
var url = '../../../../../index.html';
var hash = 'org.apache.mahout.math.indexeddataset.package';
var anchor = window.location.hash;
var anchor_opt = '';
if (anchor.length >= 1)
anchor_opt = '@' + anchor.substring(1);
window.location.href = url + '#' + hash + anchor_opt;
}
</script>
</head>
<body class="value">
<div id="definition">
<img src="../../../../../lib/package_big.png" />
<p id="owner"><a href="../../../../package.html" class="extype" name="org">org</a>.<a href="../../../package.html" class="extype" name="org.apache">apache</a>.<a href="../../package.html" class="extype" name="org.apache.mahout">mahout</a>.<a href="../package.html" class="extype" name="org.apache.mahout.math">math</a></p>
<h1>indexeddataset</h1>
</div>
<h4 id="signature" class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">package</span>
</span>
<span class="symbol">
<span class="name">indexeddataset</span>
</span>
</h4>
<div id="comment" class="fullcommenttop"><div class="toggleContainer block">
<span class="toggle">Linear Supertypes</span>
<div class="superTypes hiddenContent"><span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div>
</div></div>
<div id="mbrsel">
<div id="textfilter"><span class="pre"></span><span class="input"><input id="mbrsel-input" type="text" accesskey="/" /></span><span class="post"></span></div>
<div id="order">
<span class="filtertype">Ordering</span>
<ol>
<li class="alpha in"><span>Alphabetic</span></li>
<li class="inherit out"><span>By inheritance</span></li>
</ol>
</div>
<div id="ancestors">
<span class="filtertype">Inherited<br />
</span>
<ol id="linearization">
<li class="in" name="org.apache.mahout.math.indexeddataset"><span>indexeddataset</span></li><li class="in" name="scala.AnyRef"><span>AnyRef</span></li><li class="in" name="scala.Any"><span>Any</span></li>
</ol>
</div><div id="ancestors">
<span class="filtertype"></span>
<ol>
<li class="hideall out"><span>Hide All</span></li>
<li class="showall in"><span>Show all</span></li>
</ol>
<a href="http://docs.scala-lang.org/overviews/scaladoc/usage.html#members" target="_blank">Learn more about member selection</a>
</div>
<div id="visbl">
<span class="filtertype">Visibility</span>
<ol><li class="public in"><span>Public</span></li><li class="all out"><span>All</span></li></ol>
</div>
</div>
<div id="template">
<div id="allMembers">
<div id="types" class="types members">
<h3>Type Members</h3>
<ol><li name="org.apache.mahout.math.indexeddataset.BiDictionary" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="BiDictionaryextendsBiMap[String,Int]"></a>
<a id="BiDictionary:BiDictionary"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">class</span>
</span>
<span class="symbol">
<a href="BiDictionary.html"><span class="name">BiDictionary</span></a><span class="result"> extends <a href="BiMap.html" class="extype" name="org.apache.mahout.math.indexeddataset.BiMap">BiMap</a>[<span class="extype" name="scala.Predef.String">String</span>, <span class="extype" name="scala.Int">Int</span>]</span>
</span>
</h4>
<p class="comment cmt">BiDictionary is a specialized BiMap that has non-negative Ints as values for use as DRM keys</p>
</li><li name="org.apache.mahout.math.indexeddataset.BiMap" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="BiMap[K,V]extendsSerializable"></a>
<a id="BiMap[K,V]:BiMap[K,V]"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">class</span>
</span>
<span class="symbol">
<a href="BiMap.html"><span class="name">BiMap</span></a><span class="tparams">[<span name="K">K</span>, <span name="V">V</span>]</span><span class="result"> extends <span class="extype" name="scala.Serializable">Serializable</span></span>
</span>
</h4>
<p class="comment cmt">Immutable Bi-directional Map.</p>
</li><li name="org.apache.mahout.math.indexeddataset.IndexedDataset" visbl="pub" data-isabs="true" fullComment="no" group="Ungrouped">
<a id="IndexedDatasetextendsAnyRef"></a>
<a id="IndexedDataset:IndexedDataset"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">trait</span>
</span>
<span class="symbol">
<a href="IndexedDataset.html"><span class="name">IndexedDataset</span></a><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span>
</span>
</h4>
<p class="comment cmt">Wrap an <a href="../drm/DrmLike.html" class="extype" name="org.apache.mahout.math.drm.DrmLike">org.apache.mahout.math.drm.DrmLike</a> with bidirectional ID mappings <a href="BiDictionary.html" class="extype" name="org.apache.mahout.math.indexeddataset.BiDictionary">org.apache.mahout.math.indexeddataset.BiDictionary</a>
so a user specified labels/IDs can be stored and mapped to and from the Mahout Int ID used internal to Mahout
core code.</p>
</li><li name="org.apache.mahout.math.indexeddataset.Reader" visbl="pub" data-isabs="true" fullComment="no" group="Ungrouped">
<a id="Reader[T]extendsAnyRef"></a>
<a id="Reader[T]:Reader[T]"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">trait</span>
</span>
<span class="symbol">
<a href="Reader.html"><span class="name">Reader</span></a><span class="tparams">[<span name="T">T</span>]</span><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span>
</span>
</h4>
<p class="comment cmt">Reader trait is abstract in the sense that the elementReader and rowReader functions must be supplied by an
extending trait, which also defines the type to be read.</p>
</li><li name="org.apache.mahout.math.indexeddataset.Schema" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="SchemaextendsHashMap[String,Any]"></a>
<a id="Schema:Schema"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">class</span>
</span>
<span class="symbol">
<a href="Schema.html"><span class="name">Schema</span></a><span class="result"> extends <span class="extype" name="scala.collection.mutable.HashMap">HashMap</span>[<span class="extype" name="scala.Predef.String">String</span>, <span class="extype" name="scala.Any">Any</span>]</span>
</span>
</h4>
<p class="comment cmt">Syntactic sugar for mutable.</p>
</li><li name="org.apache.mahout.math.indexeddataset.Writer" visbl="pub" data-isabs="true" fullComment="no" group="Ungrouped">
<a id="Writer[T]extendsAnyRef"></a>
<a id="Writer[T]:Writer[T]"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">trait</span>
</span>
<span class="symbol">
<a href="Writer.html"><span class="name">Writer</span></a><span class="tparams">[<span name="T">T</span>]</span><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span>
</span>
</h4>
<p class="comment cmt">Writer trait is abstract in the sense that the writer method must be supplied by an extending trait,
which also defines the type to be written.</p>
</li></ol>
</div>
<div id="values" class="values members">
<h3>Value Members</h3>
<ol><li name="org.apache.mahout.math.indexeddataset.BiDictionary" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="BiDictionary"></a>
<a id="BiDictionary:BiDictionary"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">object</span>
</span>
<span class="symbol">
<a href="BiDictionary$.html"><span class="name">BiDictionary</span></a><span class="result"> extends <span class="extype" name="scala.Serializable">Serializable</span></span>
</span>
</h4>
<p class="comment cmt">BiDictionary is a specialized BiMap that has non-negative Ints as values for use as DRM keys.</p>
</li><li name="org.apache.mahout.math.indexeddataset.BiMap" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="BiMap"></a>
<a id="BiMap:BiMap"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">object</span>
</span>
<span class="symbol">
<a href="BiMap$.html"><span class="name">BiMap</span></a><span class="result"> extends <span class="extype" name="scala.Serializable">Serializable</span></span>
</span>
</h4>
</li><li name="org.apache.mahout.math.indexeddataset.DefaultIndexedDatasetElementReadSchema" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="DefaultIndexedDatasetElementReadSchema"></a>
<a id="DefaultIndexedDatasetElementReadSchema:DefaultIndexedDatasetElementReadSchema"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">object</span>
</span>
<span class="symbol">
<a href="DefaultIndexedDatasetElementReadSchema$.html"><span class="name">DefaultIndexedDatasetElementReadSchema</span></a><span class="result"> extends <a href="Schema.html" class="extype" name="org.apache.mahout.math.indexeddataset.Schema">Schema</a></span>
</span>
</h4>
<p class="comment cmt">Simple default Schema for typical text delimited element file input
This tells the reader to input elements of the default (rowID&lt;comma, tab, or space&gt;columnID
&lt;comma, tab, or space&gt;here may be other ignored text.</p>
</li><li name="org.apache.mahout.math.indexeddataset.DefaultIndexedDatasetReadSchema" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="DefaultIndexedDatasetReadSchema"></a>
<a id="DefaultIndexedDatasetReadSchema:DefaultIndexedDatasetReadSchema"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">object</span>
</span>
<span class="symbol">
<a href="DefaultIndexedDatasetReadSchema$.html"><span class="name">DefaultIndexedDatasetReadSchema</span></a><span class="result"> extends <a href="Schema.html" class="extype" name="org.apache.mahout.math.indexeddataset.Schema">Schema</a></span>
</span>
</h4>
<p class="comment cmt">Default Schema for typical text delimited <a href="IndexedDataset.html" class="extype" name="org.apache.mahout.math.indexeddataset.IndexedDataset">org.apache.mahout.math.indexeddataset.IndexedDataset</a> file
row-wise input.</p>
</li><li name="org.apache.mahout.math.indexeddataset.DefaultIndexedDatasetWriteSchema" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="DefaultIndexedDatasetWriteSchema"></a>
<a id="DefaultIndexedDatasetWriteSchema:DefaultIndexedDatasetWriteSchema"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">object</span>
</span>
<span class="symbol">
<a href="DefaultIndexedDatasetWriteSchema$.html"><span class="name">DefaultIndexedDatasetWriteSchema</span></a><span class="result"> extends <a href="Schema.html" class="extype" name="org.apache.mahout.math.indexeddataset.Schema">Schema</a></span>
</span>
</h4>
<p class="comment cmt">Default Schema for text delimited <a href="IndexedDataset.html" class="extype" name="org.apache.mahout.math.indexeddataset.IndexedDataset">org.apache.mahout.math.indexeddataset.IndexedDataset</a> file output with
one row per line.</p>
</li><li name="org.apache.mahout.math.indexeddataset.IndexedDatasetReadBooleanSchema" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="IndexedDatasetReadBooleanSchema"></a>
<a id="IndexedDatasetReadBooleanSchema:IndexedDatasetReadBooleanSchema"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">object</span>
</span>
<span class="symbol">
<a href="IndexedDatasetReadBooleanSchema$.html"><span class="name">IndexedDatasetReadBooleanSchema</span></a><span class="result"> extends <a href="Schema.html" class="extype" name="org.apache.mahout.math.indexeddataset.Schema">Schema</a></span>
</span>
</h4>
<p class="comment cmt">Default Schema for reading a text delimited <a href="IndexedDataset.html" class="extype" name="org.apache.mahout.math.indexeddataset.IndexedDataset">org.apache.mahout.math.indexeddataset.IndexedDataset</a> file where
the score of any element is ignored.</p>
</li><li name="org.apache.mahout.math.indexeddataset.IndexedDatasetWriteBooleanSchema" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="IndexedDatasetWriteBooleanSchema"></a>
<a id="IndexedDatasetWriteBooleanSchema:IndexedDatasetWriteBooleanSchema"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">object</span>
</span>
<span class="symbol">
<a href="IndexedDatasetWriteBooleanSchema$.html"><span class="name">IndexedDatasetWriteBooleanSchema</span></a><span class="result"> extends <a href="Schema.html" class="extype" name="org.apache.mahout.math.indexeddataset.Schema">Schema</a></span>
</span>
</h4>
<p class="comment cmt">Default Schema for typical text delimited <a href="IndexedDataset.html" class="extype" name="org.apache.mahout.math.indexeddataset.IndexedDataset">org.apache.mahout.math.indexeddataset.IndexedDataset</a> file output
where the score of a element is omitted.</p>
</li><li name="org.apache.mahout.math.indexeddataset.package#indexedDatasetDFSRead" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="indexedDatasetDFSRead(src:String,schema:org.apache.mahout.math.indexeddataset.Schema,existingRowIDs:Option[org.apache.mahout.math.indexeddataset.BiDictionary])(implicitctx:org.apache.mahout.math.drm.DistributedContext):org.apache.mahout.math.indexeddataset.IndexedDataset"></a>
<a id="indexedDatasetDFSRead(String,Schema,Option[BiDictionary])(DistributedContext):IndexedDataset"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">indexedDatasetDFSRead</span><span class="params">(<span name="src">src: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="schema">schema: <a href="Schema.html" class="extype" name="org.apache.mahout.math.indexeddataset.Schema">Schema</a> = <span class="symbol"><span class="name"><a href="DefaultIndexedDatasetReadSchema$.html">DefaultIndexedDatasetReadSchema</a></span></span></span>, <span name="existingRowIDs">existingRowIDs: <span class="extype" name="scala.Option">Option</span>[<a href="BiDictionary.html" class="extype" name="org.apache.mahout.math.indexeddataset.BiDictionary">BiDictionary</a>] = <span class="symbol">None</span></span>)</span><span class="params">(<span class="implicit">implicit </span><span name="ctx">ctx: <a href="../drm/DistributedContext.html" class="extype" name="org.apache.mahout.math.drm.DistributedContext">DistributedContext</a></span>)</span><span class="result">: <a href="IndexedDataset.html" class="extype" name="org.apache.mahout.math.indexeddataset.IndexedDataset">IndexedDataset</a></span>
</span>
</h4>
<p class="shortcomment cmt">Load IndexedDataset from text delimited files</p>
</li><li name="org.apache.mahout.math.indexeddataset.package#indexedDatasetDFSReadElements" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
<a id="indexedDatasetDFSReadElements(src:String,schema:org.apache.mahout.math.indexeddataset.Schema,existingRowIDs:Option[org.apache.mahout.math.indexeddataset.BiDictionary])(implicitctx:org.apache.mahout.math.drm.DistributedContext):org.apache.mahout.math.indexeddataset.IndexedDataset"></a>
<a id="indexedDatasetDFSReadElements(String,Schema,Option[BiDictionary])(DistributedContext):IndexedDataset"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">indexedDatasetDFSReadElements</span><span class="params">(<span name="src">src: <span class="extype" name="scala.Predef.String">String</span></span>, <span name="schema">schema: <a href="Schema.html" class="extype" name="org.apache.mahout.math.indexeddataset.Schema">Schema</a> = <span class="symbol"><span class="name"><a href="DefaultIndexedDatasetReadSchema$.html">DefaultIndexedDatasetReadSchema</a></span></span></span>, <span name="existingRowIDs">existingRowIDs: <span class="extype" name="scala.Option">Option</span>[<a href="BiDictionary.html" class="extype" name="org.apache.mahout.math.indexeddataset.BiDictionary">BiDictionary</a>] = <span class="symbol">None</span></span>)</span><span class="params">(<span class="implicit">implicit </span><span name="ctx">ctx: <a href="../drm/DistributedContext.html" class="extype" name="org.apache.mahout.math.drm.DistributedContext">DistributedContext</a></span>)</span><span class="result">: <a href="IndexedDataset.html" class="extype" name="org.apache.mahout.math.indexeddataset.IndexedDataset">IndexedDataset</a></span>
</span>
</h4>
</li></ol>
</div>
</div>
<div id="inheritedMembers">
<div class="parent" name="scala.AnyRef">
<h3>Inherited from <span class="extype" name="scala.AnyRef">AnyRef</span></h3>
</div><div class="parent" name="scala.Any">
<h3>Inherited from <span class="extype" name="scala.Any">Any</span></h3>
</div>
</div>
<div id="groupedMembers">
<div class="group" name="Ungrouped">
<h3>Ungrouped</h3>
</div>
</div>
</div>
<div id="tooltip"></div>
<div id="footer"> </div>
<script defer="defer" type="text/javascript" id="jquery-js" src="../../../../../lib/jquery.js"></script><script defer="defer" type="text/javascript" id="jquery-ui-js" src="../../../../../lib/jquery-ui.js"></script><script defer="defer" type="text/javascript" id="tools-tooltip-js" src="../../../../../lib/tools.tooltip.js"></script><script defer="defer" type="text/javascript" id="template-js" src="../../../../../lib/template.js"></script>
</body>
</html>