|
|
<!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_51) on Wed Sep 16 15:55:12 PDT 2015 -->
<title>MultivariateOnlineSummarizer</title>
<meta name="date" content="2015-09-16">
<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="MultivariateOnlineSummarizer";
}
//-->
</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="../../../../../org/apache/spark/mllib/stat/KernelDensity.html" title="class in org.apache.spark.mllib.stat"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/spark/mllib/stat/MultivariateStatisticalSummary.html" title="interface in org.apache.spark.mllib.stat"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/spark/mllib/stat/MultivariateOnlineSummarizer.html" target="_top">Frames</a></li>
<li><a href="MultivariateOnlineSummarizer.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: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </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.spark.mllib.stat</div>
<h2 title="Class MultivariateOnlineSummarizer" class="title">Class MultivariateOnlineSummarizer</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.spark.mllib.stat.MultivariateOnlineSummarizer</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable, <a href="../../../../../org/apache/spark/mllib/stat/MultivariateStatisticalSummary.html" title="interface in org.apache.spark.mllib.stat">MultivariateStatisticalSummary</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">MultivariateOnlineSummarizer</span>
extends java.lang.Object
implements <a href="../../../../../org/apache/spark/mllib/stat/MultivariateStatisticalSummary.html" title="interface in org.apache.spark.mllib.stat">MultivariateStatisticalSummary</a>, scala.Serializable</pre>
<div class="block">:: DeveloperApi ::
MultivariateOnlineSummarizer implements <a href="../../../../../org/apache/spark/mllib/stat/MultivariateStatisticalSummary.html" title="interface in org.apache.spark.mllib.stat"><code>MultivariateStatisticalSummary</code></a> to compute the mean,
variance, minimum, maximum, counts, and nonzero counts for samples in sparse or dense vector
format in a online fashion.
<p>
Two MultivariateOnlineSummarizer can be merged together to have a statistical summary of
the corresponding joint dataset.
<p>
A numerically stable algorithm is implemented to compute sample mean and variance:
Reference: <code>variance-wiki</code>
Zero elements (including explicit zero values) are skipped when calling add(),
to have time complexity O(nnz) instead of O(n) for each column.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../serialized-form.html#org.apache.spark.mllib.stat.MultivariateOnlineSummarizer">Serialized Form</a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/spark/mllib/stat/MultivariateOnlineSummarizer.html#MultivariateOnlineSummarizer()">MultivariateOnlineSummarizer</a></strong>()</code> </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"> </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><a href="../../../../../org/apache/spark/mllib/stat/MultivariateOnlineSummarizer.html" title="class in org.apache.spark.mllib.stat">MultivariateOnlineSummarizer</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/stat/MultivariateOnlineSummarizer.html#add(org.apache.spark.mllib.linalg.Vector)">add</a></strong>(<a href="../../../../../org/apache/spark/mllib/linalg/Vector.html" title="interface in org.apache.spark.mllib.linalg">Vector</a> sample)</code>
<div class="block">Add a new sample to this summarizer, and update the statistical summary.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/stat/MultivariateOnlineSummarizer.html#count()">count</a></strong>()</code>
<div class="block">Sample size.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/mllib/linalg/Vector.html" title="interface in org.apache.spark.mllib.linalg">Vector</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/stat/MultivariateOnlineSummarizer.html#max()">max</a></strong>()</code>
<div class="block">Maximum value of each dimension.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/mllib/linalg/Vector.html" title="interface in org.apache.spark.mllib.linalg">Vector</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/stat/MultivariateOnlineSummarizer.html#mean()">mean</a></strong>()</code>
<div class="block">Sample mean of each dimension.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/mllib/stat/MultivariateOnlineSummarizer.html" title="class in org.apache.spark.mllib.stat">MultivariateOnlineSummarizer</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/stat/MultivariateOnlineSummarizer.html#merge(org.apache.spark.mllib.stat.MultivariateOnlineSummarizer)">merge</a></strong>(<a href="../../../../../org/apache/spark/mllib/stat/MultivariateOnlineSummarizer.html" title="class in org.apache.spark.mllib.stat">MultivariateOnlineSummarizer</a> other)</code>
<div class="block">Merge another MultivariateOnlineSummarizer, and update the statistical summary.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/mllib/linalg/Vector.html" title="interface in org.apache.spark.mllib.linalg">Vector</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/stat/MultivariateOnlineSummarizer.html#min()">min</a></strong>()</code>
<div class="block">Minimum value of each dimension.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/mllib/linalg/Vector.html" title="interface in org.apache.spark.mllib.linalg">Vector</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/stat/MultivariateOnlineSummarizer.html#normL1()">normL1</a></strong>()</code>
<div class="block">L1 norm of each dimension.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/mllib/linalg/Vector.html" title="interface in org.apache.spark.mllib.linalg">Vector</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/stat/MultivariateOnlineSummarizer.html#normL2()">normL2</a></strong>()</code>
<div class="block">L2 (Euclidian) norm of each dimension.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/mllib/linalg/Vector.html" title="interface in org.apache.spark.mllib.linalg">Vector</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/stat/MultivariateOnlineSummarizer.html#numNonzeros()">numNonzeros</a></strong>()</code>
<div class="block">Number of nonzero elements in each dimension.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/mllib/linalg/Vector.html" title="interface in org.apache.spark.mllib.linalg">Vector</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/stat/MultivariateOnlineSummarizer.html#variance()">variance</a></strong>()</code>
<div class="block">Sample variance of each dimension.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class 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="MultivariateOnlineSummarizer()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MultivariateOnlineSummarizer</h4>
<pre>public MultivariateOnlineSummarizer()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="add(org.apache.spark.mllib.linalg.Vector)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre>public <a href="../../../../../org/apache/spark/mllib/stat/MultivariateOnlineSummarizer.html" title="class in org.apache.spark.mllib.stat">MultivariateOnlineSummarizer</a> add(<a href="../../../../../org/apache/spark/mllib/linalg/Vector.html" title="interface in org.apache.spark.mllib.linalg">Vector</a> sample)</pre>
<div class="block">Add a new sample to this summarizer, and update the statistical summary.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sample</code> - The sample in dense/sparse vector format to be added into this summarizer.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This MultivariateOnlineSummarizer object.</dd></dl>
</li>
</ul>
<a name="merge(org.apache.spark.mllib.stat.MultivariateOnlineSummarizer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>merge</h4>
<pre>public <a href="../../../../../org/apache/spark/mllib/stat/MultivariateOnlineSummarizer.html" title="class in org.apache.spark.mllib.stat">MultivariateOnlineSummarizer</a> merge(<a href="../../../../../org/apache/spark/mllib/stat/MultivariateOnlineSummarizer.html" title="class in org.apache.spark.mllib.stat">MultivariateOnlineSummarizer</a> other)</pre>
<div class="block">Merge another MultivariateOnlineSummarizer, and update the statistical summary.
(Note that it's in place merging; as a result, <code>this</code> object will be modified.)
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>other</code> - The other MultivariateOnlineSummarizer to be merged.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This MultivariateOnlineSummarizer object.</dd></dl>
</li>
</ul>
<a name="mean()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mean</h4>
<pre>public <a href="../../../../../org/apache/spark/mllib/linalg/Vector.html" title="interface in org.apache.spark.mllib.linalg">Vector</a> mean()</pre>
<div class="block">Sample mean of each dimension.
<p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/spark/mllib/stat/MultivariateStatisticalSummary.html#mean()">mean</a></code> in interface <code><a href="../../../../../org/apache/spark/mllib/stat/MultivariateStatisticalSummary.html" title="interface in org.apache.spark.mllib.stat">MultivariateStatisticalSummary</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="variance()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>variance</h4>
<pre>public <a href="../../../../../org/apache/spark/mllib/linalg/Vector.html" title="interface in org.apache.spark.mllib.linalg">Vector</a> variance()</pre>
<div class="block">Sample variance of each dimension.
<p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/spark/mllib/stat/MultivariateStatisticalSummary.html#variance()">variance</a></code> in interface <code><a href="../../../../../org/apache/spark/mllib/stat/MultivariateStatisticalSummary.html" title="interface in org.apache.spark.mllib.stat">MultivariateStatisticalSummary</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="count()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>count</h4>
<pre>public long count()</pre>
<div class="block">Sample size.
<p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/spark/mllib/stat/MultivariateStatisticalSummary.html#count()">count</a></code> in interface <code><a href="../../../../../org/apache/spark/mllib/stat/MultivariateStatisticalSummary.html" title="interface in org.apache.spark.mllib.stat">MultivariateStatisticalSummary</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="numNonzeros()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>numNonzeros</h4>
<pre>public <a href="../../../../../org/apache/spark/mllib/linalg/Vector.html" title="interface in org.apache.spark.mllib.linalg">Vector</a> numNonzeros()</pre>
<div class="block">Number of nonzero elements in each dimension.
<p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/spark/mllib/stat/MultivariateStatisticalSummary.html#numNonzeros()">numNonzeros</a></code> in interface <code><a href="../../../../../org/apache/spark/mllib/stat/MultivariateStatisticalSummary.html" title="interface in org.apache.spark.mllib.stat">MultivariateStatisticalSummary</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="max()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>max</h4>
<pre>public <a href="../../../../../org/apache/spark/mllib/linalg/Vector.html" title="interface in org.apache.spark.mllib.linalg">Vector</a> max()</pre>
<div class="block">Maximum value of each dimension.
<p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/spark/mllib/stat/MultivariateStatisticalSummary.html#max()">max</a></code> in interface <code><a href="../../../../../org/apache/spark/mllib/stat/MultivariateStatisticalSummary.html" title="interface in org.apache.spark.mllib.stat">MultivariateStatisticalSummary</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="min()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>min</h4>
<pre>public <a href="../../../../../org/apache/spark/mllib/linalg/Vector.html" title="interface in org.apache.spark.mllib.linalg">Vector</a> min()</pre>
<div class="block">Minimum value of each dimension.
<p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/spark/mllib/stat/MultivariateStatisticalSummary.html#min()">min</a></code> in interface <code><a href="../../../../../org/apache/spark/mllib/stat/MultivariateStatisticalSummary.html" title="interface in org.apache.spark.mllib.stat">MultivariateStatisticalSummary</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="normL2()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>normL2</h4>
<pre>public <a href="../../../../../org/apache/spark/mllib/linalg/Vector.html" title="interface in org.apache.spark.mllib.linalg">Vector</a> normL2()</pre>
<div class="block">L2 (Euclidian) norm of each dimension.
<p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/spark/mllib/stat/MultivariateStatisticalSummary.html#normL2()">normL2</a></code> in interface <code><a href="../../../../../org/apache/spark/mllib/stat/MultivariateStatisticalSummary.html" title="interface in org.apache.spark.mllib.stat">MultivariateStatisticalSummary</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="normL1()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>normL1</h4>
<pre>public <a href="../../../../../org/apache/spark/mllib/linalg/Vector.html" title="interface in org.apache.spark.mllib.linalg">Vector</a> normL1()</pre>
<div class="block">L1 norm of each dimension.
<p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/spark/mllib/stat/MultivariateStatisticalSummary.html#normL1()">normL1</a></code> in interface <code><a href="../../../../../org/apache/spark/mllib/stat/MultivariateStatisticalSummary.html" title="interface in org.apache.spark.mllib.stat">MultivariateStatisticalSummary</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</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="../../../../../org/apache/spark/mllib/stat/KernelDensity.html" title="class in org.apache.spark.mllib.stat"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/spark/mllib/stat/MultivariateStatisticalSummary.html" title="interface in org.apache.spark.mllib.stat"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/spark/mllib/stat/MultivariateOnlineSummarizer.html" target="_top">Frames</a></li>
<li><a href="MultivariateOnlineSummarizer.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: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<script defer="defer" type="text/javascript" src="../../../../../lib/jquery.js"></script><script defer="defer" type="text/javascript" src="../../../../../lib/api-javadocs.js"></script></body>
</html>
|
