blob: 8331ea2322854671fd55c2fe691e4ac2f79b7351 [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_162) on Thu Oct 25 17:06:10 PDT 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>DoubleSummaryFactory (com.yahoo.datasketches:sketches-core 0.12.1-SNAPSHOT API)</title>
<meta name="date" content="2018-10-25">
<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="DoubleSummaryFactory (com.yahoo.datasketches:sketches-core 0.12.1-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance 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/DoubleSummaryFactory.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="../../../../com/yahoo/sketches/tuple/DoubleSummaryDeserializer.html" title="class in com.yahoo.sketches.tuple"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/yahoo/sketches/tuple/DoubleSummarySetOperations.html" title="class in com.yahoo.sketches.tuple"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/yahoo/sketches/tuple/DoubleSummaryFactory.html" target="_top">Frames</a></li>
<li><a href="DoubleSummaryFactory.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">com.yahoo.sketches.tuple</div>
<h2 title="Class DoubleSummaryFactory" class="title">Class DoubleSummaryFactory</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://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>com.yahoo.sketches.tuple.DoubleSummaryFactory</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../com/yahoo/sketches/tuple/SummaryFactory.html" title="interface in com.yahoo.sketches.tuple">SummaryFactory</a>&lt;<a href="../../../../com/yahoo/sketches/tuple/DoubleSummary.html" title="class in com.yahoo.sketches.tuple">DoubleSummary</a>&gt;</dd>
</dl>
<hr>
<br>
<pre>public final class <span class="typeNameLabel">DoubleSummaryFactory</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="../../../../com/yahoo/sketches/tuple/SummaryFactory.html" title="interface in com.yahoo.sketches.tuple">SummaryFactory</a>&lt;<a href="../../../../com/yahoo/sketches/tuple/DoubleSummary.html" title="class in com.yahoo.sketches.tuple">DoubleSummary</a>&gt;</pre>
<div class="block">Factory for DoubleSummary. It supports three modes of operation of DoubleSummary:
Sum, Min and Max.</div>
</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="../../../../com/yahoo/sketches/tuple/DoubleSummaryFactory.html#DoubleSummaryFactory--">DoubleSummaryFactory</a></span>()</code>
<div class="block">Creates an instance of DoubleSummaryFactory with default mode</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/tuple/DoubleSummaryFactory.html#DoubleSummaryFactory-com.yahoo.sketches.tuple.DoubleSummary.Mode-">DoubleSummaryFactory</a></span>(<a href="../../../../com/yahoo/sketches/tuple/DoubleSummary.Mode.html" title="enum in com.yahoo.sketches.tuple">DoubleSummary.Mode</a>&nbsp;summaryMode)</code>
<div class="block">Creates an instance of DoubleSummaryFactory with a given mode</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="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="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="../../../../com/yahoo/sketches/tuple/DeserializeResult.html" title="class in com.yahoo.sketches.tuple">DeserializeResult</a>&lt;<a href="../../../../com/yahoo/sketches/tuple/DoubleSummaryFactory.html" title="class in com.yahoo.sketches.tuple">DoubleSummaryFactory</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/tuple/DoubleSummaryFactory.html#fromMemory-com.yahoo.memory.Memory-">fromMemory</a></span>(com.yahoo.memory.Memory&nbsp;mem)</code>
<div class="block">This is deprecated and exists here just to test compatibility with previous serialization format.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../com/yahoo/sketches/tuple/DoubleSummary.html" title="class in com.yahoo.sketches.tuple">DoubleSummary</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/tuple/DoubleSummaryFactory.html#newSummary--">newSummary</a></span>()</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="https://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="https://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="https://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="https://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="https://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="https://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="https://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="https://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="https://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="https://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="https://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="https://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="DoubleSummaryFactory--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DoubleSummaryFactory</h4>
<pre>public&nbsp;DoubleSummaryFactory()</pre>
<div class="block">Creates an instance of DoubleSummaryFactory with default mode</div>
</li>
</ul>
<a name="DoubleSummaryFactory-com.yahoo.sketches.tuple.DoubleSummary.Mode-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DoubleSummaryFactory</h4>
<pre>public&nbsp;DoubleSummaryFactory(<a href="../../../../com/yahoo/sketches/tuple/DoubleSummary.Mode.html" title="enum in com.yahoo.sketches.tuple">DoubleSummary.Mode</a>&nbsp;summaryMode)</pre>
<div class="block">Creates an instance of DoubleSummaryFactory with a given mode</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>summaryMode</code> - summary mode</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="newSummary--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newSummary</h4>
<pre>public&nbsp;<a href="../../../../com/yahoo/sketches/tuple/DoubleSummary.html" title="class in com.yahoo.sketches.tuple">DoubleSummary</a>&nbsp;newSummary()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../com/yahoo/sketches/tuple/SummaryFactory.html#newSummary--">newSummary</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../com/yahoo/sketches/tuple/SummaryFactory.html" title="interface in com.yahoo.sketches.tuple">SummaryFactory</a>&lt;<a href="../../../../com/yahoo/sketches/tuple/DoubleSummary.html" title="class in com.yahoo.sketches.tuple">DoubleSummary</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>new instance of Summary</dd>
</dl>
</li>
</ul>
<a name="fromMemory-com.yahoo.memory.Memory-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>fromMemory</h4>
<pre>public static&nbsp;<a href="../../../../com/yahoo/sketches/tuple/DeserializeResult.html" title="class in com.yahoo.sketches.tuple">DeserializeResult</a>&lt;<a href="../../../../com/yahoo/sketches/tuple/DoubleSummaryFactory.html" title="class in com.yahoo.sketches.tuple">DoubleSummaryFactory</a>&gt;&nbsp;fromMemory(com.yahoo.memory.Memory&nbsp;mem)</pre>
<div class="block">This is deprecated and exists here just to test compatibility with previous serialization format.
In the current serial version of sketches factories are not serialized.
Creates an instance of the DoubleSummaryFactory given a serialized representation</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mem</code> - Memory object with serialized DoubleSummaryFactory</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>DeserializedResult object, which contains a DoubleSummaryFactory object and number of
bytes read from the Memory</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/DoubleSummaryFactory.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="../../../../com/yahoo/sketches/tuple/DoubleSummaryDeserializer.html" title="class in com.yahoo.sketches.tuple"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/yahoo/sketches/tuple/DoubleSummarySetOperations.html" title="class in com.yahoo.sketches.tuple"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/yahoo/sketches/tuple/DoubleSummaryFactory.html" target="_top">Frames</a></li>
<li><a href="DoubleSummaryFactory.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; 2015&#x2013;2018. All rights reserved.</small></p>
</body>
</html>