blob: 25971248f116fedb19400ac9555d0fecfcf9fd1c [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_112) on Mon Dec 18 11:25:20 EST 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Aggregations (Apache Edgent (incubating) v1.2.0 API)</title>
<meta name="date" content="2017-12-18">
<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="Aggregations (Apache Edgent (incubating) v1.2.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/Aggregations.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>Prev&nbsp;Class</li>
<li><a href="../../../../../org/apache/edgent/analytics/math3/MvResultMap.html" title="class in org.apache.edgent.analytics.math3"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/edgent/analytics/math3/Aggregations.html" target="_top">Frames</a></li>
<li><a href="Aggregations.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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.edgent.analytics.math3</div>
<h2 title="Class Aggregations" class="title">Class Aggregations</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/8/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.edgent.analytics.math3.Aggregations</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">Aggregations</span>
extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Apache Common Math analytics for Collections.
<p>These operations are typically used when processing a collection of tuples
in a non-partitioned or partitioned <a href="../../../../../org/apache/edgent/topology/TWindow.html" title="interface in org.apache.edgent.topology"><code>TWindow</code></a>.
<p>Simple sum aggregation functions are also provided (helpful given the avoidance
of depending on Java8 Streams).
<p>Example: compute a batched MEAN aggregation for a simple unpartitioned window of
numeric <code>TStream&lt;Double&gt;</code> where the desired result is a <code>TStream&lt;Double&gt;</code> of
the MEAN values:
<pre><code>
TStream&lt;Double&gt; pressureReadings = ...
TWindow&lt;Double,Integer&gt; window = pressureReadings.last(5, Functions.unpartitioned());
TStream&lt;Double&gt; meanPressureReadings = window.batch(
(list, partition) -&gt; Aggregations.aggregate(list, Statistic2.MEAN));
</code></pre>
<p>Example: compute the MEAN and SLOPE, capturing the results in a <a href="../../../../../org/apache/edgent/analytics/math3/ResultMap.html" title="class in org.apache.edgent.analytics.math3"><code>ResultMap</code></a>:
<pre><code>
TStream&lt;Double&gt; pressureReadings = ...
TWindow&lt;Double,Integer&gt; window = pressureReadings.last(5, Functions.unpartitioned());
TStream&lt;ResultMap&gt; meanPressureReadings = window.batch(
(list, partition) -&gt; Aggregations.aggregateN(list, Statistic2.MEAN, Regression2.SLOPE));
</code></pre>
<p>Example: compute multiple aggregations on multiple variables in a tuple T,
capturing the results in a <a href="../../../../../org/apache/edgent/analytics/math3/MvResultMap.html" title="class in org.apache.edgent.analytics.math3"><code>MvResultMap</code></a>:
<pre><code>
class SensorReading {
double getTemp() {...};
double getPressure() {...};
... };
TStream&lt;SensorReading&gt; readings = ...
TWindow&lt;SensorReading,Integer&gt; window = sensorReadings.last(5, Functions.unpartitioned());
TStream&lt;MvResultMap&gt; aggregations = window.batch(
(list, partition) -&gt; {
ResultMap pressureResults = Aggregations.aggregateN(list, t -&gt; t.getPressure(), Statistic2.MEAN, Regression2.SLOPE));
ResultMap tempResults = Aggregations.aggregateN(list, t -&gt; t.getTemp(), Statistic2.MAX));
MvResultMap results = Aggregations.newMvResults();
results.put("pressure", pressureResults);
results.put("temp", tempResults);
return results;
});
</code></pre>
<p>Example: convert a <code>TStream&lt;ResultMap&gt;</code> or <code>TStream&lt;MvResultMap&gt;</code> to a JsonObject:
<pre><code>
TStream&lt;ResultMap&gt; resultMap = ...
TStream&lt;JsonObject&gt; joResultMap = resultMap.map(ResultMap.toJsonObject());
</code></pre>
<p>Background:
<a href="../../../../../org/apache/edgent/analytics/math3/json/JsonAnalytics.html" title="class in org.apache.edgent.analytics.math3.json"><code>JsonAnalytics</code></a> predates this class. Use of JsonAnalytics for computing
Apache Commons Math aggregations requires:
<ul>
<li>the input stream tuple type must be a JsonObject and the user must identify
the property that contains the value to be aggregated.</li>
<li>batched window aggregations are not supported (they could be added).</li>
<li>the aggregation result tuple is a JsonObject that holds a user-specified
property for a window partition key and a user-specified property
for a JsonObject holding the UnivariateAggregation results by name (e.g., "MEAN").
Accessing a particular aggregation results in the JsonObject
is somewhat cumbersome.</li>
</ul>
<p>As a result, using JsonAnalytics for simple cases can be a bit unintuitive and cumbersome.
<p>For example, to JsonAnalytics for a simple case of a continuous aggregation
of <code>TStream&lt;Double&gt;</code> =&gt; <code>TStream&lt;Double&gt;</code> of MEAN values:
<pre><code>
TStream&lt;Double&gt; pressureReadings = ...
// transform TStream&lt;Double&gt; to TStream&lt;JsonObject&gt;
TStream&lt;JsonObject&gt; joPressureReadings = pressureReadings.map(JsonFunctions.valueOfDouble("pressure"));
// aggregate
TWindow&lt;JsonObject,JsonElement&gt; window = joPressureReadings.last(5, JsonFunctions.unpartitioned());
TStream&lt;JsonObject&gt; results = JsonAnalytics.aggregate(window, "partition", "pressure", Statistic.MEAN);
// transform to TStream&lt;Double&gt; mean results
TStream&lt;Double&gt; meanPressureReadings = results.map(jo -&gt; jo.get("pressure").getAsObject().get("MEAN").getAsDouble());
</code></pre>
<p>Using Aggregations it's simply:
<pre><code>
TWindow&lt;Double,Integer&gt; window = pressureReadings.last(5, Functions.unpartitioned());
TStream&lt;Double&gt; meanPressureReadings = window.aggregate(
(list, partition) -&gt; Aggregations.aggregate(list, Statistic2.MEAN));
</code></pre></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/edgent/analytics/math3/stat/Statistic2.html" title="enum in org.apache.edgent.analytics.math3.stat"><code>Statistic2</code></a>,
<a href="../../../../../org/apache/edgent/analytics/math3/stat/Regression2.html" title="enum in org.apache.edgent.analytics.math3.stat"><code>Regression2</code></a>,
<a href="../../../../../org/apache/edgent/analytics/math3/json/JsonAnalytics.html" title="class in org.apache.edgent.analytics.math3.json"><code>JsonAnalytics</code></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="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="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/math3/Aggregations.html#Aggregations--">Aggregations</a></span>()</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="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>static <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/math3/Aggregations.html#aggregate-java.util.Collection-org.apache.edgent.analytics.math3.UnivariateAggregate-">aggregate</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;? extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a>&gt;&nbsp;c,
<a href="../../../../../org/apache/edgent/analytics/math3/UnivariateAggregate.html" title="interface in org.apache.edgent.analytics.math3">UnivariateAggregate</a>&nbsp;aggregate)</code>
<div class="block">Perform the specified <a href="../../../../../org/apache/edgent/analytics/math3/UnivariateAggregate.html" title="interface in org.apache.edgent.analytics.math3"><code>UnivariateAggregate</code></a> on a Collection of <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang"><code>Number</code></a>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static &lt;T&gt;&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/math3/Aggregations.html#aggregate-java.util.Collection-org.apache.edgent.function.ToDoubleFunction-org.apache.edgent.analytics.math3.UnivariateAggregate-">aggregate</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;T&gt;&nbsp;c,
<a href="../../../../../org/apache/edgent/function/ToDoubleFunction.html" title="interface in org.apache.edgent.function">ToDoubleFunction</a>&lt;T&gt;&nbsp;getter,
<a href="../../../../../org/apache/edgent/analytics/math3/UnivariateAggregate.html" title="interface in org.apache.edgent.analytics.math3">UnivariateAggregate</a>&nbsp;aggregate)</code>
<div class="block">Perform the specified <a href="../../../../../org/apache/edgent/analytics/math3/UnivariateAggregate.html" title="interface in org.apache.edgent.analytics.math3"><code>UnivariateAggregate</code></a> a Collection of <code>T</code>
using the specified <a href="../../../../../org/apache/edgent/function/ToDoubleFunction.html" title="interface in org.apache.edgent.function"><code>getter</code></a> to extract the
variable to aggregate.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/edgent/analytics/math3/ResultMap.html" title="class in org.apache.edgent.analytics.math3">ResultMap</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/math3/Aggregations.html#aggregateN-java.util.Collection-org.apache.edgent.analytics.math3.UnivariateAggregate...-">aggregateN</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;? extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a>&gt;&nbsp;c,
<a href="../../../../../org/apache/edgent/analytics/math3/UnivariateAggregate.html" title="interface in org.apache.edgent.analytics.math3">UnivariateAggregate</a>...&nbsp;aggregates)</code>
<div class="block">Perform the specified <a href="../../../../../org/apache/edgent/analytics/math3/UnivariateAggregate.html" title="interface in org.apache.edgent.analytics.math3"><code>UnivariateAggregate</code></a> on a Collection of <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang"><code>Number</code></a>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static &lt;T&gt;&nbsp;<a href="../../../../../org/apache/edgent/analytics/math3/ResultMap.html" title="class in org.apache.edgent.analytics.math3">ResultMap</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/math3/Aggregations.html#aggregateN-java.util.Collection-org.apache.edgent.function.ToDoubleFunction-org.apache.edgent.analytics.math3.UnivariateAggregate...-">aggregateN</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;T&gt;&nbsp;c,
<a href="../../../../../org/apache/edgent/function/ToDoubleFunction.html" title="interface in org.apache.edgent.function">ToDoubleFunction</a>&lt;T&gt;&nbsp;getter,
<a href="../../../../../org/apache/edgent/analytics/math3/UnivariateAggregate.html" title="interface in org.apache.edgent.analytics.math3">UnivariateAggregate</a>...&nbsp;aggregates)</code>
<div class="block">Perform the specified <a href="../../../../../org/apache/edgent/analytics/math3/UnivariateAggregate.html" title="interface in org.apache.edgent.analytics.math3"><code>UnivariateAggregate</code></a> a Collection of <code>T</code>
using the specified <a href="../../../../../org/apache/edgent/function/ToDoubleFunction.html" title="interface in org.apache.edgent.function"><code>getter</code></a> to extract the
variable to aggregate.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/math3/Aggregations.html#sum-java.util.Collection-">sum</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;? extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a>&gt;&nbsp;list)</code>
<div class="block">Perform a sum of numbers treated as double values, accumulating in a double.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/math3/Aggregations.html#sumInts-java.util.Collection-">sumInts</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;? extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a>&gt;&nbsp;list)</code>
<div class="block">Perform a sum of numbers treated as long values, accumulating in a long.</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&nbsp;java.lang.<a href="http://docs.oracle.com/javase/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Aggregations--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Aggregations</h4>
<pre>public&nbsp;Aggregations()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="sum-java.util.Collection-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sum</h4>
<pre>public static&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</a>&nbsp;sum(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;? extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a>&gt;&nbsp;list)</pre>
<div class="block">Perform a sum of numbers treated as double values, accumulating in a double.
An empty list yields a 0.0 result.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>list</code> - numbers to sum</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the sum</dd>
</dl>
</li>
</ul>
<a name="sumInts-java.util.Collection-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sumInts</h4>
<pre>public static&nbsp;long&nbsp;sumInts(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;? extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a>&gt;&nbsp;list)</pre>
<div class="block">Perform a sum of numbers treated as long values, accumulating in a long.
More efficient than sum() for non-floating point values.
An empty list yields a 0 result.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>list</code> - numbers to sum</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the sum</dd>
</dl>
</li>
</ul>
<a name="aggregate-java.util.Collection-org.apache.edgent.analytics.math3.UnivariateAggregate-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>aggregate</h4>
<pre>public static&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</a>&nbsp;aggregate(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;? extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a>&gt;&nbsp;c,
<a href="../../../../../org/apache/edgent/analytics/math3/UnivariateAggregate.html" title="interface in org.apache.edgent.analytics.math3">UnivariateAggregate</a>&nbsp;aggregate)</pre>
<div class="block">Perform the specified <a href="../../../../../org/apache/edgent/analytics/math3/UnivariateAggregate.html" title="interface in org.apache.edgent.analytics.math3"><code>UnivariateAggregate</code></a> on a Collection of <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang"><code>Number</code></a>.
<p>A null result is returned if the collection is empty.
An aggregation result may be null under other conditions,
e.g., a Regression2.SLOPE where the minimum number of samples has not been met.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>c</code> - the Collection to aggregate</dd>
<dd><code>aggregate</code> - the aggregation to perform</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the aggregation result, may be null.</dd>
</dl>
</li>
</ul>
<a name="aggregateN-java.util.Collection-org.apache.edgent.analytics.math3.UnivariateAggregate...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>aggregateN</h4>
<pre>public static&nbsp;<a href="../../../../../org/apache/edgent/analytics/math3/ResultMap.html" title="class in org.apache.edgent.analytics.math3">ResultMap</a>&nbsp;aggregateN(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;? extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a>&gt;&nbsp;c,
<a href="../../../../../org/apache/edgent/analytics/math3/UnivariateAggregate.html" title="interface in org.apache.edgent.analytics.math3">UnivariateAggregate</a>...&nbsp;aggregates)</pre>
<div class="block">Perform the specified <a href="../../../../../org/apache/edgent/analytics/math3/UnivariateAggregate.html" title="interface in org.apache.edgent.analytics.math3"><code>UnivariateAggregate</code></a> on a Collection of <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang"><code>Number</code></a>.
<p>If the collection is empty an empty ResultMap is returned.
The ResultMap does not contain an entry for an aggregation with a null,
e.g., a Regression2.SLOPE where the minimum number of samples has not been met.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>c</code> - the Collection to aggregate</dd>
<dd><code>aggregates</code> - the aggregations to perform</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="../../../../../org/apache/edgent/analytics/math3/ResultMap.html" title="class in org.apache.edgent.analytics.math3"><code>ResultMap</code></a> containing the variable's aggregation results</dd>
</dl>
</li>
</ul>
<a name="aggregate-java.util.Collection-org.apache.edgent.function.ToDoubleFunction-org.apache.edgent.analytics.math3.UnivariateAggregate-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>aggregate</h4>
<pre>public static&nbsp;&lt;T&gt;&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</a>&nbsp;aggregate(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;T&gt;&nbsp;c,
<a href="../../../../../org/apache/edgent/function/ToDoubleFunction.html" title="interface in org.apache.edgent.function">ToDoubleFunction</a>&lt;T&gt;&nbsp;getter,
<a href="../../../../../org/apache/edgent/analytics/math3/UnivariateAggregate.html" title="interface in org.apache.edgent.analytics.math3">UnivariateAggregate</a>&nbsp;aggregate)</pre>
<div class="block">Perform the specified <a href="../../../../../org/apache/edgent/analytics/math3/UnivariateAggregate.html" title="interface in org.apache.edgent.analytics.math3"><code>UnivariateAggregate</code></a> a Collection of <code>T</code>
using the specified <a href="../../../../../org/apache/edgent/function/ToDoubleFunction.html" title="interface in org.apache.edgent.function"><code>getter</code></a> to extract the
variable to aggregate.
<p>A null result is returned if the collection is empty.
An aggregation result may be null under other conditions,
e.g., a Regression2.SLOPE where the minimum number of samples has not been met.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - Tuple type</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>c</code> - the Collection to aggregate</dd>
<dd><code>getter</code> - function that returns the variable to aggregate from a <code>T</code></dd>
<dd><code>aggregate</code> - the aggregation to perform</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the aggregation result, may be null.</dd>
</dl>
</li>
</ul>
<a name="aggregateN-java.util.Collection-org.apache.edgent.function.ToDoubleFunction-org.apache.edgent.analytics.math3.UnivariateAggregate...-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>aggregateN</h4>
<pre>public static&nbsp;&lt;T&gt;&nbsp;<a href="../../../../../org/apache/edgent/analytics/math3/ResultMap.html" title="class in org.apache.edgent.analytics.math3">ResultMap</a>&nbsp;aggregateN(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;T&gt;&nbsp;c,
<a href="../../../../../org/apache/edgent/function/ToDoubleFunction.html" title="interface in org.apache.edgent.function">ToDoubleFunction</a>&lt;T&gt;&nbsp;getter,
<a href="../../../../../org/apache/edgent/analytics/math3/UnivariateAggregate.html" title="interface in org.apache.edgent.analytics.math3">UnivariateAggregate</a>...&nbsp;aggregates)</pre>
<div class="block">Perform the specified <a href="../../../../../org/apache/edgent/analytics/math3/UnivariateAggregate.html" title="interface in org.apache.edgent.analytics.math3"><code>UnivariateAggregate</code></a> a Collection of <code>T</code>
using the specified <a href="../../../../../org/apache/edgent/function/ToDoubleFunction.html" title="interface in org.apache.edgent.function"><code>getter</code></a> to extract the
variable to aggregate.
<p>If the collection is empty an empty ResultMap is returned.
The ResultMap does not contain an entry for an aggregation with a null,
e.g., a Regression2.SLOPE where the minimum number of samples has not been met.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - Tuple type</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>c</code> - the Collection to aggregate</dd>
<dd><code>getter</code> - function that returns the variable to aggregate from a <code>T</code></dd>
<dd><code>aggregates</code> - the aggregations to perform</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="../../../../../org/apache/edgent/analytics/math3/ResultMap.html" title="class in org.apache.edgent.analytics.math3"><code>ResultMap</code></a> containing the variable's aggregation results</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>
<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/Aggregations.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>Prev&nbsp;Class</li>
<li><a href="../../../../../org/apache/edgent/analytics/math3/MvResultMap.html" title="class in org.apache.edgent.analytics.math3"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/edgent/analytics/math3/Aggregations.html" target="_top">Frames</a></li>
<li><a href="Aggregations.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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2016&#x2013;2017 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>